List invitations sent for a merchant

curl -G https://api-sandbox.koywe.com/api/v1/users/organizations/organizationId/merchants/merchantId/invitations \
     -H "Authorization: Bearer <token>" \
     -d pageNumber=1

{
  "pagination": {
    "current": 1,
    "next": 1.1,
    "previous": 1.1,
    "totalPages": 1,
    "totalCount": 1,
    "pageSize": "pageSize",
    "sort": "sort"
  },
  "invitations": [
    {
      "id": "inv_xxxxxxxxxxxxxx",
      "email": "user@example.com",
      "roles": [
        "ADMIN_ROLE",
        "VIEWER_ROLE"
      ],
      "status": "PENDING",
      "expiresAt": "2024-08-15T10:00:00Z",
      "createdAt": "2024-08-08T10:00:00Z",
      "invitedByUserId": "k3u_yyyyyyyyyyyyyy",
      "merchantId": "mrc_zzzzzzzzzzzzzz",
      "acceptedAt": "2024-08-09T10:00:00Z",
      "acceptedByUserId": "k3u_xxxxxxxxxxxxxx"
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID to list invitations for

Query parameters

pageSizedoubleOptional

Number of invitations per page

pageNumberdoubleOptionalDefaults to 1

Page number to retrieve

sortenumOptional

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

Allowed values:

Response

List of invitations retrieved successfully.

paginationobject

invitationslist of objects

List of invitations

List invitations sent for a merchant

Authentication

Path parameters

Headers

Query parameters

Response

Errors