---
title: "Preview invitation"
method: GET
path: "/invitations/{token}/preview"
tags: ["invitations"]
---

# Preview invitation

`GET /invitations/{token}/preview`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/invitations/{token}/preview`
- Auth: HTTP bearer

Public preview for the invite page: group, inviter and member first names, with the status (valid, expired, used, full). Answers for unusable invitations too; 404 only when the token does not exist. Never includes email addresses.

## Path parameters

- `token` string, required

## Response `200`

Invitation preview retrieved successfully

- object
  - `data` InvitationPreviewResponseDto
    - `status` 'valid' | 'expired' | 'used' | 'full', required
    - `groupId` string, required
    - `groupName` string, required
    - `groupIcon` string, nullable
    - `groupColor` string, nullable
    - `inviterName` string, required
    - `inviterAvatarUrl` string, nullable
    - `memberCount` number, required: Active members with an account
    - `memberFirstNames` string[], required: First names of up to 4 members, inviter first
    - `isGroupLink` boolean, required
    - `isEmailInvite` boolean, required
    - `claimableGuestCount` number, required: Guests a joiner could take over
    - `expiresAt` string, required: ISO8601 expiration timestamp
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

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