Get Organization Invitations By Organization ID
DescriptionGet invitations for specific organization. If expand parameter is passed to the request user invitation roles will be returned in the response.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Unique identifier of the group.
Indicates if response should be expanded, value is ignored - only the existence of parameter is checked.
Indicates if custom groups response should be expanded.
Authentication
Response
Response BodyResponse Body
200 OK
array of
UserOrganizationInvitationResponse
of type application/json
{
"status": "AVAILABLE"
}
The username of the user.
The expiration time of the invitation.
The creation timestamp in milliseconds.
The Creator ot the invitation (usually client identifier).
Deprecated: the common Invitation Link.
Invited By, specify the actual user who is inviting.
List of organization role names.
Custom Groups Identifiers (relevant only for invite).
The redemption timestamp in milliseconds.
The name of the invitation redeemer.
The reference link of the Invitation.
The revoke timestamp in milliseconds.
The name of invitation revoker.
The status of the invitation.
Possible values are: AVAILABLE , REDEEMED , REVOKED
Errors
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found.
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_admin,org_owner
x-slo-tier: TIER2
