---
title: "Preview an invite by its token, without accepting it"
method: POST
path: "/members:preview"
tags: ["Members"]
---

# Preview an invite by its token, without accepting it

`POST /members:preview`

## Request

- Base URL: `https://api.customdomain.ai/v1`
- URL: `https://api.customdomain.ai/v1/members:preview`
- Auth: none required

What an invite link is for: the invited email, the workspace, the role, who sent it, and whether it still works. Nothing is accepted or spent. Public: the token is the capability, exactly as for `members:accept`, and it travels in the body so it never lands in an access log. A link that stopped working says why (`accepted`, `expired`, `revoked`, or `replaced` by a newer invite to the same address); a token that was never issued is a 404. Rate-limited per client address.

## Request body

- object
  - `token` string, required: The invite token from the invite link.

## Response `200`

The invite

- InvitePreview
  - `status` 'pending' | 'accepted' | 'expired' | 'revoked' | 'replaced', required: `pending`: the link works. `accepted`: it was used. `expired`: it lapsed. `revoked`: an admin withdrew the invite. `replaced`: a newer invite was sent to the same address.
  - `email` string, required: The invited address.
  - `role` 'owner' | 'admin' | 'member' | 'viewer', required
  - `tenant_id` string, required
  - `workspace_name` string, required: The tenant's display name.
  - `inviter_name` string
  - `inviter_email` string
  - `invited_at` string, date-time
  - `expires_at` string, date-time: When the link stops (or stopped) working. Absent when it never expires.

## Other responses

- `400`: Error envelope: {code, title, details}.
- `404`: Error envelope: {code, title, details}.
- `429`: Error envelope: {code, title, details}.

---

[API](https://skmtc.dev/customdomain/apis/customdomain-control-plane-api.md) · [All operations](https://skmtc.dev/customdomain/apis/customdomain-control-plane-api/llms.txt) · [OpenAPI document](https://skmtc.dev/customdomain/apis/customdomain-control-plane-api/revisions/34d89cb7a7cd?raw)