agency-users

List agency invitations

Retrieve a list of pending invitations for the agency. Use the query parameters to navigate through the results.

Scope: agency-users:read

get/agencies/{agencyId}/invitations

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/agencies/{agencyId}/invitations
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

Response

List of agency invitations

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "email": "user@example.com",
      "status": "pendingInvitation"
    }
  ]
}

Changes

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