Logto API references

Get organization invitations

GET /api/organization-invitations

Get organization invitations with pagination.

Query parameters

organizationId string
inviterId string
invitee string

Responses

• 200 application/json

A list of organization invitations, each item also contains the organization roles to be assigned to the user when they accept the invitation.
Hide response attributes Show response attributes object
- id string Required
  
  Minimum length is 1, maximum length is 21.
- inviterId string | null Required
  
  Maximum length is 21.
- invitee string Required
  
  Minimum length is 1, maximum length is 256.
- acceptedUserId string | null Required
  
  Maximum length is 21.
- organizationId string Required
  
  Minimum length is 1, maximum length is 21.
- status string Required
  
  Values are Pending, Accepted, Expired, or Revoked.
- createdAt number Required
- updatedAt number Required
- expiresAt number Required
- organizationRoles array[object] Required
  
  Hide organizationRoles attributes Show organizationRoles attributes object
  
  id string Required
  
  name string Required
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden

GET /api/organization-invitations

curl \
 -X GET https://[tenant_id].logto.app/api/organization-invitations

Response examples (200)

[
  {
    "id": "string",
    "inviterId": "string",
    "invitee": "string",
    "acceptedUserId": "string",
    "organizationId": "string",
    "status": "Pending",
    "createdAt": 42.0,
    "updatedAt": 42.0,
    "expiresAt": 42.0,
    "organizationRoles": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]