List open invitations

GET

/invitations

const url = 'https://example.com/invitations';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

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 \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

sessionCookie
invitations:read
apiKey
invitations:read

Responses

200

Invitations

application/json

object

items

required

Array<object>

object

required

UUID v7

string format: uuid

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

acceptedAt

required

string | null format: date-time

revokedAt

required

string | null format: date-time

createdAt

required

string format: date-time

total

required

integer

Example

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "role": "owner"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

Not a member, or the role is not allowed to do this

application/json

object

error

required

string

message

required

string

Example

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