List organization invitations

get/api/v1/users/organizations/{organizationId}/invitations

Request

Base URL: https://api-sandbox.koywe.com
URL: https://api-sandbox.koywe.com/api/v1/users/organizations/{organizationId}/invitations
Auth: HTTP bearer

Path parameters

organizationIdstring required

Organization ID

Query parameters

pageSize10 | 20 | 50 | 100

Number of invitations per page

pageNumbernumber

Example:1

Page number to retrieve

sort'asc' | 'desc'

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

Response

List of organization invitations retrieved successfully.

Example response

{
  "pagination": {
    "current": 1,
    "totalPages": 1,
    "totalCount": 1
  },
  "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:00.000Z",
      "createdAt": "2024-08-08T10:00:00.000Z",
      "acceptedAt": "2024-08-09T10:00:00.000Z",
      "acceptedByUserId": "k3u_xxxxxxxxxxxxxx",
      "invitedByUserId": "k3u_yyyyyyyyyyyyyy",
      "organizationId": "org3_zzzzzzzzzzzzzz"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.