Organization invitations

Get organization invitation

Changed on

Get an organization invitation by ID.

get/api/organization-invitations/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/organization-invitations/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the organization invitation.

Response

The organization invitation, also contains the organization roles to be assigned to the user when they accept the invitation.

tenantIdstring required
idstring required
inviterIdstring nullable required
inviteestring required
acceptedUserIdstring nullable required
organizationIdstring required
status'Pending' | 'Accepted' | 'Expired' | 'Revoked' required
createdAtnumber required
updatedAtnumber required
expiresAtnumber required

Changes

  • f6be196bc327Revision changes
    • breaking

      the response property's maxLength was increased from 21 to 128 for the response status

    • breaking

      the response property's maxLength was increased from 21 to 128 for the response status