List tenant invitations

GET

/api/admin/tenants/{id}/invitations

Code sample: Shell / cURL

curl --request GET \
  --url 'https://auth.example.com/api/admin/tenants/example/invitations?limit=50&offset=0&include_expired=false' \
  --header 'Authorization: Bearer <token>'

Lists tenant invitations with pagination. Invitation tokens are intentionally omitted from list items.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Query Parameters

limit

integer

default: 50 >= 1 <= 100

Maximum invitations to return.

offset

integer

0

Pagination offset.

include_expired

boolean

Include expired invitations.

Responses

200

Tenant invitation list. Tokens are intentionally omitted from list items.

Media type application/json

object

items

Array<object>

object

id

string

tenant_id

string

invited_email

string | null format: email

invited_by

string

role_id

string | null

org_id

string | null

max_uses

integer

use_count

integer

expires_at

integer format: int64

created_at

integer format: int64

updated_at

integer format: int64

key

additional properties

total

integer

limit

integer

offset

integer

key

additional properties

Example

{
  "items": [
    {
      "id": "inv_123",
      "tenant_id": "tenant_123",
      "invited_email": "[email protected]",
      "invited_by": "admin_123",
      "role_id": "role_tenant_admin",
      "org_id": "org_123",
      "max_uses": 1,
      "use_count": 0,
      "expires_at": 1770259200,
      "created_at": 1770000000,
      "updated_at": 1770000000
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}