Skip to content
Authrim

List Admin invitations.

GET
/api/admin/admin-invitations
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/admin-invitations?include_completed=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Query Parameters

Section titled “Query Parameters ”
include_completed
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenant-scoped Admin invitations.

Media type application/json
object
items
required
Array<object>
object
id
required
string
tenant_id
required
string
email
required
string format: email
name
string | null
status
required
string
Allowed values: pending accepted revoked expired
role
required
object
id
required
string
name
required
string
display_name
string | null
scope_type
required
string
Allowed values: global tenant
scope_id
string | null
role_expires_at
integer | null format: int64
ip_restriction_enabled
required
boolean
allowed_ip_ranges
required
Array<string>
<= 5 items
expires_at
required
integer format: int64
last_sent_at
required
integer format: int64
last_delivery_status
required
string
Allowed values: pending sent failed
accepted_at
integer | null format: int64
created_by
string
created_at
integer format: int64
updated_at
integer format: int64
total
required
integer
Example 
{
  "items": [
    {
      "status": "pending",
      "scope_type": "global",
      "last_delivery_status": "pending"
    }
  ]
}