---
title: "Preview a site invite"
method: GET
path: "/api/v1/invites/{token}"
tags: ["Members"]
---

# Preview a site invite

`GET /api/v1/invites/{token}`

## Request

- Base URL: `https://api.dotsy.ai`
- URL: `https://api.dotsy.ai/api/v1/invites/{token}`
- Auth: none required

What an invite link offers: which site, which role and who invited. It needs no sign-in, so the page behind the link can show it before the person logs in. It never returns site content or the invited email address.

## Path parameters

- `token` string, required

## Response `200`

The invite.

- InvitePreview
  - `valid` boolean, required: True when the invite can still be accepted.
  - `expired` boolean, required
  - `alreadyAccepted` boolean, required
  - `siteSlug` string, nullable, required
  - `siteTitle` string, nullable, required
  - `workspaceName` string, nullable, required
  - `role` 'editor' | 'viewer', required
  - `invitedBy` string, nullable, required: The inviter's name, or their email when they have no name.
  - `expiresAt` number, required: Unix ms.

## Other responses

- `404`: `invite_not_found`: the token matches no invite.

---

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