List organization invitations

curl -G https://api-sandbox.koywe.com/api/v1/users/organizations/organizationId/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": "orginv_xxxxxxxxxxxxxx",
      "email": "user@example.com",
      "roles": [
        "k3r_user_org_inviter",
        "k3r_user_org_viewer",
        "k3r_user_org_manager"
      ],
      "status": "PENDING",
      "expiresAt": "2024-08-15T10:00:00Z",
      "createdAt": "2024-08-08T10:00:00Z",
      "invitedByUserId": "k3u_yyyyyyyyyyyyyy",
      "organizationId": "org3_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

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 organization invitations retrieved successfully.

paginationobject

invitationslist of objects

List of organization invitations

Errors

400

List Organization Invitations Request Bad Request Error

401

List Organization Invitations Request Unauthorized Error

403

List Organization Invitations Request Forbidden Error

422

List Organization Invitations Request Unprocessable Entity Error

500

List Organization Invitations Request Internal Server Error