---
title: "List customer invitations"
method: GET
path: "/customers/invitations"
tags: ["Customers"]
---

# List customer invitations

`GET /customers/invitations`

List pending invitations addressed to specific customers

## Query parameters

- `cursor` string — Cursor from the previous page.
- `limit` integer — Maximum results per page.

## Headers

- `X-Instance-ID` string, nullable

## Response `200`

Successful Response

- object
  - `data` object[], required
    - `type` 'customerInvitation', required — Resource type. Always `customerInvitation`.
    - `id` string, required — Recipient email.
    - `attributes` object, required
      - `status` string, required — Invitation status.
      - `party` object, nullable, required — Customer party, or null until they join Natural.
        - `id` string, required — Customer party ID (pty_*).
        - `name` string, required — Customer name.
        - `email` string, nullable, required — Email address.
        - `avatarUrl` string, uri, nullable, required — Public avatar URL, or null when none is set.
        - `createdAt` string, date-time, nullable, required — RFC 3339 timestamp when the customer's party was created, or null when unknown.
      - `email` string, required — Recipient email.
      - `createdAt` string, date-time, required — RFC 3339 timestamp when the invitation was created.
      - `agentInvitations` object[], required — Agent invitations sent to this recipient.
        - `invitationId` string, required — Invitation ID (adi_*).
        - `agent` object, required — Invited agent.
          - `id` string, required — Agent ID (agt_*).
          - `name` string, nullable, required — Agent name.
          - `handle` string, nullable, required — Agent handle, such as @acme-support, or null when none is set.
        - `permissions` string[], required — Permissions requested for this agent.
        - `url` string, uri, required — Invitation URL. Natural sends it automatically for email invitations; deliver it yourself for phone invitations.
        - `createdAt` string, date-time, required — RFC 3339 timestamp when the invitation was created.
        - `expiresAt` string, date-time, nullable, required — RFC 3339 timestamp when the invitation expires, or null when it never expires.
        - `tags` object, required — Metadata visible to anyone who can read the resource.
  - `meta` object, required
    - `pagination` object, required
      - `hasMore` boolean, required — Whether more results are available.
      - `nextCursor` string, nullable, required — Cursor for the next page, or null when there are no more results.

## Other responses

- `400` — Validation Error
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found. Returned when the resource does not exist, or when it exists but is not accessible to your account. The two cases are intentionally indistinguishable, so that resource IDs cannot be enumerated by probing.
- `409` — Conflict
- `422` — Validation Error. The response contains one error object for each invalid request value.
- `428` — Precondition Required
- `429` — Too Many Requests
- `500` — Internal Server Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

## Changes

- **2026-09-02** `c7c12da5915f` — 12 info
  - added the optional property `errors/items/meta/limitScope` to the response with the `400` status
  - added the optional property `errors/items/meta/limitScope` to the response with the `401` status
  - added the optional property `errors/items/meta/limitScope` to the response with the `403` status
  - added the optional property `errors/items/meta/limitScope` to the response with the `404` status
  - …8 more
- **2026-08-27** `359d267dca88` — 1 info
  - deleted the `header` request parameter `X-Agent-ID` with deprecation
- **2026-08-23** `b1ad79e918ac` — 1 info
  - `header` request parameter `X-Agent-ID` was deprecated
- **2026-07-26** `270e233e401c` — 1 warning, 1 info
  - for the `query` request parameter `cursor`, the maxLength was set to `1024`
  - added the required property `data/items/attributes/agentInvitations/items/agent/handle` to the response with the `200` status
- **2026-07-14** `8cc2aed45847` — 1 info
  - added the required property `data/items/attributes/party/anyOf[subschema #1: CustomerParty]/avatarUrl` to the response with the `200` status

[Change history](https://skmtc.dev/natural/apis/natural-api/changes/customers/invitations/get.md)

---

[API](https://skmtc.dev/natural/apis/natural-api.md) · [All operations](https://skmtc.dev/natural/apis/natural-api/llms.txt) · [OpenAPI document](https://skmtc.dev/natural/apis/natural-api/revisions/6e52d1bd0054?raw)