Sign in
Invitations

List zone invitations

List invitations for a zone with cursor-based pagination. Filter by exact match with filter[email], filter[status], filter[created_by_email] (each repeatable for OR). Substring search via query[email], query[created_by_email], or query[] (searches across email and inviter email). Non-empty query parameters combine with AND. Sort: comma-separated field list; prefix with - for descending. Use expand[]=total_count to include the matching row count.

get/zones/{zoneId}/invitations

Path parameters

zoneIdstring required

Zone ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
'pending' | 'accepted' | 'expired'

Status of a zone invitation

OR
IamInvitationStatus[]
string email

Filter by exact email address

OR
string[]
'pending' | 'accepted' | 'expired'

Status of a zone invitation

OR
IamInvitationStatus[]
string email

Filter by inviter email address

OR
string[]
string

Search by email (substring match)

OR
string[]
string

Search by inviter email (substring match)

OR
string[]
string

Search across email and inviter email (substring match)

OR
string[]
sortstring

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, email, created_by_email, expires_at, last_sent_at, status

Response

Default Response

Changes

Changed in 3 of the 23 revisions of this API.14

  • 2abdf2efe2e61See the full diff
    • ▲

      the response property items/items/last_sent_at became nullable for the status 200

      response-property-became-nullable

  • d3d69f45bfed3See the full diff
    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b31See the full diff
    • ○

      endpoint added

      endpoint-added