---
title: "List invitation links"
method: GET
path: "/customers/invitation-links"
tags: ["Invitation Links"]
---

# List invitation links

`GET /customers/invitation-links`

List the invitation links you have created, with masked tokens

## Query parameters

- `statusFilter` 'ACTIVE' | 'REVOKED' — Filter by status.
- `limit` integer — Maximum results per page.
- `cursor` string — Cursor from the previous page.

## Headers

- `X-Instance-ID` string, nullable

## Response `200`

Successful Response

- object
  - `data` object[], required
    - `type` 'invitationLink', required — Resource type. Always `invitationLink`.
    - `id` string, required — Invitation link ID (ivl_*).
    - `attributes` object, required
      - `proposedAgents` object[], required — Agents offered to customers who open this link.
        - `agentId` string, required — Agent ID (agt_*).
        - `permissions` string[], required — Permissions granted to this agent when a customer approves.
        - `limits` object, nullable, required — Transaction limits
      - `status` 'ACTIVE' | 'REVOKED', required — Link status.
      - `createdAt` string, required — RFC 3339 timestamp when this link was created.
      - `name` string, required — Label for this link.
      - `expiresAt` string, nullable, required — RFC 3339 timestamp when this link stops accepting new customers, or null when it never expires.
      - `tags` object, required — Metadata visible to anyone who can read the resource.
      - `maskedToken` string, required — Link token with all but the last 4 characters masked (for example ***bc4d). The full token and URL are returned only when the link is created.
    - `relationships` object, required
      - `delegateeParty` object, required — Party that created this link.
        - `data` object, nullable, required — Related resource identifier.
          - `type` 'party', required — Resource type. Always `party`.
          - `id` string, required
  - `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-19** `6e52d1bd0054` — 2 warning
  - added the new `voice_sessions.create` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
  - added the new `voice_sessions.read` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
- **2026-09-19** `7dd2420be291` — 3 warning
  - added the new `chargebacks.respond` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
  - added the new `disputes.create` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
  - added the new `disputes.read` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
- **2026-09-18** `fd694514e004` — 1 warning
  - added the new `refunds.create` enum value to the `data/items/attributes/proposedAgents/items/permissions/items/` response property for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/natural/apis/natural-api/changes/customers/invitation-links/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/b61b8441fba4?raw)