---
title: "List zone invitations"
method: GET
path: "/zones/{zoneId}/invitations"
tags: ["Invitations"]
---

# List zone invitations

`GET /zones/{zoneId}/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.

## Path parameters

- `zoneId` string, required

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `expand[]` union
  - 'total_count'
  - string[]
- `status` union
  - 'pending' | 'accepted' | 'expired' — Status of a zone invitation
  - IamInvitationStatus[]
- `filter[email]` union
  - string, email — Filter by exact email address
  - string[]
- `filter[status]` union
  - 'pending' | 'accepted' | 'expired' — Status of a zone invitation
  - IamInvitationStatus[]
- `filter[created_by_email]` union
  - string, email — Filter by inviter email address
  - string[]
- `query[email]` union
  - string — Search by email (substring match)
  - string[]
- `query[created_by_email]` union
  - string — Search by inviter email (substring match)
  - string[]
- `query[]` union
  - string — Search across email and inviter email (substring match)
  - string[]
- `sort` string

## Response `200`

Default Response

- object
  - `items` IamInvitation[], required
    - `id` string, required — Unique identifier of the invitation
    - `organization_id` string, required — Organization that owns this invitation
    - `zone_id` string, required — Zone this invitation belongs to
    - `email` string, email, required — Email address the invitation was sent to
    - `status` 'pending' | 'accepted' | 'expired', required — Status of a zone invitation
    - `created_by` string, required — ID of the user who created the invitation
    - `created_by_email` string, email — Email address of the user who created the invitation
    - `expires_at` string, date-time, required — Date when the invitation expires
    - `last_sent_at` string, date-time, required — Date when the invitation email was last sent
    - `created_at` string, date-time, required — Entity creation timestamp
    - `updated_at` string, date-time, required — Entity update timestamp
  - `pagination` IamPagination, required — Cursor-based pagination metadata
    - `after_cursor` string, required — An opaque cursor used for paginating through a list of results
    - `before_cursor` string, required — An opaque cursor used for paginating through a list of results
    - `total_count` integer — Total number of items matching the query. Only included when expand[]=total_count is requested.

## Other responses

- `401` — Error response
- `default` — Error response

---

[API](https://skmtc.net/keycardai/apis/untitled-api.md) · [All operations](https://skmtc.net/keycardai/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keycardai/untitled-api/versions/2f5033ed4491/schema)