Get a person

GET

/console/users/{id}

const url = 'https://example.com/console/users/example';
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/console/users/example \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

consoleRole
support

Parameters

Path Parameters

required

string

>= 1 characters

Responses

200

The person, with every business they belong to

application/json

object

required

string

email

required

string

name

required

string

emailVerified

required

boolean

twoFactorEnabled

required

boolean

createdAt

required

string format: date-time

lockedAt

required

string | null format: date-time

lockedReason

required

string | null

staffRole

required

string | null

Allowed values: support billing owner

memberships

required

Array<object>

object

tenantId

required

UUID v7

string format: uuid

tenantName

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

Example

{
  "staffRole": "support",
  "memberships": [
    {
      "tenantId": "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 Bottle staff, no two-step sign-in, or a console role too low for this

application/json

object

error

required

string

message

required

string

Example

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

404

Not found

application/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}