List Invitations

GET /api/auth/organizations/invitations

List Invitations

cURL

curl --request GET \
  --url https://api.example.com/api/auth/organizations/invitations \
  --header 'X-Organization-Id: <x-organization-id>'

Response

{
  "invitations": [
    {
      "invite_id": "inv_xyz789",
      "email": "[e-mail]",
      "client_id": "org_abc123",
      "role": "user",
      "invited_by": "user_def456",
      "status": "pending",
      "created_at": "2024-03-01T12:00:00Z",
      "expires_at": "2024-03-08T12:00:00Z"
    }
  ]
}

Retrieve a list of all pending invitations for your organization.

Request

X-Organization-Id · string · required

The unique identifier of the organization.

Response

invitations · array

List of invitation objects for the organization.

Show Invitation Object

invite_id · string

The unique identifier for the invitation.

email · string

The email address that the invitation was sent to.

client_id · string

The organization ID associated with the invitation.

role · string

The role assigned to the invitation.

invited_by · string

The user ID of the person who created the invitation.

status · string

The status of the invitation (e.g., pending, accepted, cancelled).

created_at · string

The timestamp when the invitation was created.

expires_at · string

The timestamp when the invitation will expire.

Response

{
  "invitations": [
    {
      "invite_id": "inv_xyz789",
      "email": "[e-mail]",
      "client_id": "org_abc123",
      "role": "user",
      "invited_by": "user_def456",
      "status": "pending",
      "created_at": "2024-03-01T12:00:00Z",
      "expires_at": "2024-03-08T12:00:00Z"
    }
  ]
}