---
title: "Preview an invitation (public — used from the email link)"
method: GET
path: "/api/v1/user-invitations/preview"
tags: ["User Invitations"]
---

# Preview an invitation (public — used from the email link)

`GET /api/v1/user-invitations/preview`

Preview an invitation (public — used from the email link)

## Query parameters

- `token` string, required — Raw invitation token from the email link

## Response `200`

Success

- InvitationPreviewResponse — Response containing an invitation preview
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required — Minimal invitation preview — safe for unauthenticated display
    - `email` string, email, required — Invitee email address
    - `scope_type` union, required — Scope type of the invitation
      - 'partner'
      - 'merchant'
    - `scope_name` string, required — Display name of the partner or merchant
    - `role` string, required — Role that will be granted
    - `expires_at` string, date-time, required — When this invitation expires
    - `status` string, required — Current status of the invitation

## Other responses

- `404` — Not Found
- `410` — Response

---

[API](https://skmtc.net/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.net/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)
