Sign in
Organizations

Get organization invites

Changed on

Get a list of invitations for an organization. By default, only pending (non-revoked, non-accepted) invitations are returned.

<div> <code>read:organization_invites</code> </div>
get/api/v1/organization/{org_code}/invites

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/organization/{org_code}/invites
  • Auth: HTTP bearer

Path parameters

org_codestring required
Example:org_1ccfb819462

The organization's code.

Query parameters

sort'created_on_asc' | 'created_on_desc' | 'email_asc' | 'email_desc' | 'name_asc' | 'name_desc' nullable
Example:created_on_desc

Field and order to sort the result by.

page_sizeinteger nullable
Example:10

Number of results per page. Defaults to 10 if parameter not sent.

next_tokenstring nullable

A string to get the next page of results if there are more results.

include_revokedboolean nullable

Include revoked invitations in the results.

include_acceptedboolean nullable

Include accepted invitations in the results.

Response

Invitations successfully retrieved.

codestring

Response code.

messagestring

Response message.

next_tokenstring nullable

Pagination token.

Example response

{
  "code": "OK",
  "message": "Success",
  "invites": [
    {
      "id": "inv_abc123def456",
      "code": "inv_abc123def456",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "created_on": "2024-11-18T13:32:03+11",
      "is_sent": true,
      "accepted_on": "2024-11-19T10:15:30+11",
      "roles": [
        {
          "key": "admin",
          "name": "Administrator"
        },
        {
          "key": "manager",
          "name": "Manager"
        }
      ],
      "invite_link": "https://example.kinde.com/team_invitation?code=inv_abc123def456"
    }
  ]
}

Changes