---
title: "An invitation, from the link in its email: the organization, the role and the invited address, masked. No credential; the token is the credential"
method: GET
path: "/v1/invitations/{token}"
---

# An invitation, from the link in its email: the organization, the role and the invited address, masked. No credential; the token is the credential

`GET /v1/invitations/{token}`

## Request

- Base URL: `https://api.evictionsapi.com`
- URL: `https://api.evictionsapi.com/v1/invitations/{token}`
- Auth: none required

## Path parameters

- `token` string, required

## Response `200`

The invitation. `accountExists` says whether the invited address already has an account (then the person signs in to accept).

- object
  - `organizationName` string, required
  - `role` 'owner' | 'member' | 'viewer', required
  - `emailMasked` string, required: The first letter and the domain of the invited address, such as `s•••@example.com`.
  - `accountExists` boolean, required

## Other responses

- `404`: `invitation_invalid`: the token is unknown, already used, revoked or expired.
- `429`: Too many requests from this address: at most 30 every 10 minutes, counting both invitation endpoints. `Retry-After` gives the seconds to wait.

---

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