# What an invitation is to

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-auth-invitation

`GET /api/v1/auth/invitation`

What an invitation is to. Whoever holds the link may ask; nobody else can.

## Parameters

- `token` (in path, needed)

## The answer

200, `InvitationShown`: What an invitation is to, shown to whoever holds its link.

- `account` (string, needed)
- `email` (string, needed)
- `expires` (integer, needed)
- `known` (boolean): This address already signs in here: the invitation is accepted by signing in with it, and asks for no name and no password.
- `may_visitors` (boolean, needed)
- `role` (string, needed)
- `sites` (list of string or null): Names. `null` is every site.

## Asking

```sh
curl https://tidekeeper.eu/api/v1/auth/invitation \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```