List invitations waiting for you

GET

/me/invitations

const url = 'https://example.com/me/invitations';
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/me/invitations

Live invitations addressed to your email, from any business. Empty, with emailUnverified true, until your address is confirmed.

Responses

200

Waiting for you

application/json

object

items

required

Array<object>

object

required

UUID v7

string format: uuid

tenant

required

object

required

UUID v7

string format: uuid

name

required

string

slug

required

string

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

emailUnverified

required

boolean

Example

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

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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