Get an invitation by token

GET

/invitations/lookup

const url = 'https://example.com/invitations/lookup?token=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/invitations/lookup?token=example'

Deliberately unauthenticated: the signup page shows “Join Acme Gas as a driver” before the invitee has an account. Returns only the tenant name, the role and who invited them.

Parameters

Query Parameters

token

required

The raw token from the invitation link

string

>= 1 characters

The raw token from the invitation link

Responses

200

The offer

application/json

object

tenant

required

object

required

UUID v7

string format: uuid

name

required

string

slug

required

string

email

required

string format: email

role

required

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string

Allowed values: owner admin driver

invitedByName

required

string | null

expiresAt

required

string format: date-time

Example

{
  "tenant": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "name": "Acme Gas",
    "slug": "acme-gas"
  },
  "role": "owner"
}

404

Unknown, already used, revoked or expired

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}