---
title: "Get invitation link"
method: GET
path: "/customers/invitation-links/{linkId}"
tags: ["Invitation Links"]
---

# Get invitation link

`GET /customers/invitation-links/{linkId}`

Get an invitation link and its offered agents, with a masked token

## Path parameters

- `linkId` string, required — Link handle (ivl_xxx)

## Headers

- `X-Agent-ID` string, nullable
- `X-Instance-ID` string, nullable

## Response `200`

Successful Response

- object
  - `data` object, required
    - `type` 'invitationLink', required — Resource type
    - `id` string, required — Link ID (ivl_*)
    - `attributes` object, required — Resource attributes
      - `proposedAgents` object[], required — Agents proposed for authorization
        - `agentId` string, required — Agent ID (agt_*)
        - `permissions` string[], required — Permissions for this agent
        - `limits` object, nullable, required — Transaction limits
      - `status` 'ACTIVE' | 'REVOKED', required — Link status
      - `createdAt` string, required — When this link was created
      - `name` string, required — Label for this link
      - `expiresAt` string, nullable, required — When this link expires
      - `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 — Resource relationships
      - `delegateeParty` object, required — Developer party that created this link
        - `data` object, nullable, required — Related resource identifier.
          - `type` 'party', required
          - `id` string, required

## 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
- `428` — Precondition Required
- `429` — Too Many Requests
- `500` — Internal Server Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

---

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