List invitations sent for a merchant

1 import requests 2 3 url = "https://api.koywe.com/api/v1/users/organizations/orgId/merchants/merchantId/invitations" 4 5 querystring = {"email":"user@example.com","status":"PENDING","limit":"10","page":"1"} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "pagination": { 3 "current": 1, 4 "next": 1.1, 5 "previous": 1.1, 6 "totalPages": 1, 7 "totalCount": 1, 8 "pageSize": "pageSize", 9 "sort": "sort" 10 }, 11 "invitations": [ 12 { 13 "id": "inv_xxxxxxxxxxxxxx", 14 "email": "user@example.com", 15 "roles": [ 16 "ADMIN_ROLE", 17 "VIEWER_ROLE" 18 ], 19 "status": "PENDING", 20 "expiresAt": "2024-08-15T10:00:00Z", 21 "createdAt": "2024-08-08T10:00:00Z", 22 "invitedByUserId": "k3u_yyyyyyyyyyyyyy", 23 "merchantId": "mrc_zzzzzzzzzzzzzz", 24 "acceptedAt": "2024-08-09T10:00:00Z", 25 "acceptedByUserId": "k3u_xxxxxxxxxxxxxx" 26 } 27 ] 28 }

Path parameters

orgIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID to list invitations for

Query parameters

pageSizedoubleOptionalDefaults to 10

Number of invitations per page

pageNumberdoubleOptionalDefaults to 1

Page number to retrieve

sortenumOptionalDefaults to desc

Sort order for invitations (e.g., by createdAt)

Allowed values:

emailstringOptional

Filter by invitee email address

statusstringOptional

Filter by invitation status (e.g., PENDING, ACCEPTED, EXPIRED)

limitdoubleOptional

Number of items per page

pagedoubleOptional

Page number for pagination

Response

List of invitations retrieved successfully.

paginationobject

invitationslist of objects

List of invitations

List invitations sent for a merchant

Path parameters

Headers

Query parameters

Response

Errors