What an invitation is to

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

# 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"
```

Parameters

tokenin the address

needed

The answer

Status 200

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

account

stringneeded

email

stringneeded

expires

integerneeded

known

booleanThis address already signs in here: the invitation is accepted by signing in with it, and asks for no name and no password.

may_visitors

booleanneeded

role

stringneeded

sites

list of string or nullNames. `null` is every site.

Asking

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

const answer = await fetch("https://tidekeeper.eu/api/v1/auth/invitation", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());