Skip to content
Bottle

List people

GET
/console/users
curl --request GET \
  --url 'https://example.com/console/users?limit=50' \
  --cookie bottle.session_token=<bottle.session_token>

Every account on Bottle, or those whose name or email matches q.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 80 characters
limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

People

Media typeapplication/json
object
items
required
Array<object>
object
id
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
total
required
integer
Example
{
  "items": [
    {
      "staffRole": "support",
      "memberships": [
        {
          "tenantId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "role": "owner"
        }
      ]
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/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"
    }
  ]
}