What an invitation is for

GET

/invitations/{token}

curl --request GET \
  --url https://api.sloose.com/invitations/k3f%E2%80%A6

• Production

The organisation, the role and the invited address behind a link, so the account app can show them before the person signs in. Needs no authentication: the token is the secret, and this answers nothing the email did not already say.

Parameters

Path Parameters

token

required

The token from the invitation link.

string

Example

k3f…

The token from the invitation link.

Responses

200

The invitation.

Media typeapplication/json

object

orgName

required

The organisation’s name, or “a team” when it could be read as coming from Sloose.

string

role

required

string

Allowed values: operator builder admin

email

required

string

invitedBy

required

The inviter’s name, or “Someone at …” when it could be read as coming from Sloose or the inviter has gone.

string

expiresAt

required

string

Example

{
  "role": "operator"
}

404

No such invitation, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

409

The invitation was withdrawn (INVITATION_REVOKED), already used (INVITATION_USED) or has expired (INVITATION_EXPIRED). A used one also carries orgId, orgName and acceptedAt, so the page can tell a member who opens it again that they are already in (#730).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).