GET
/api/organizations/{organization_id}/invitationsAuthenticatedList an organization's invitations
Lists every invitation of the organization (pending, accepted, declined, revoked and expired) with the inviter's and invitee's e-mail addresses. Organization owners and platform administrators only.
operationId
get_api_organizations_organization_id_invitationsOrganizationsAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
- Notes
- Only organization owners or platform administrators may list invitations.
Path parameters
| Name | Type | Description |
|---|---|---|
| organization_id* | string | Organization id (URL-safe slug) |
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | object | |
| invitations* | OrganizationInvitationListEntry[] | |
| invitation_id* | string (uuid) | |
| organization_id* | string | minLength: 4maxLength: 32pattern: ^[a-z][a-z0-9_-]+$ |
| organization_name | string | |
| inviter_uid* | string (uuid) | |
| inviter_email* | string (email) | E-mail address of the inviting user |
| invitee_uid* | string (uuid) | |
| invitee_email* | string (email) | E-mail address of the invited user |
| status* | "pending" | "accepted" | "declined" | "revoked" | "expired" | |
| created_at* | number | exclusiveMinimum: 0 |
| expires_at* | number | exclusiveMinimum: 0 |
| responded_at | number | null | null | exclusiveMinimum: 0 |
JSONExample
"success"true
"message""string"
"data"
"invitations"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/organizations/<organization_id>/invitations' \
-b 'refresh_token_<auth_server_app_id>=<value>'