Skip to content
Bottle

List API keys

GET
/api-keys
curl --request GET \
  --url https://example.com/api-keys \
  --cookie bottle.session_token=<bottle.session_token>

Revoked keys are left out. The key itself is never returned: only the prefix, which is what identifies a row in this list.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Keys

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
prefix
required
string
scopes
required
Array<string>
Allowed values: tenant:read tenant:write customers:read customers:write products:read products:write tax:read tax:write orders:read orders:write rounds:read rounds:write drivers:read drivers:write rota:read rota:write timeoff:write handovers:write deliveries:write cash:read cash:write stock:read stock:write invoices:read invoices:write members:read members:write invitations:read invitations:write keys:read keys:write connections:read connections:write shops:read shops:write billing:read billing:write privacy:read privacy:write accounting:read accounting:write setup:read setup:write emails:read console:read console:write console:owner
createdAt
required
string format: date-time
lastUsedAt
required
string | null format: date-time
expiresAt
required
string | null format: date-time
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "name": "Xero sync",
      "prefix": "btl_7f3a9c21",
      "scopes": [
        "tenant:read"
      ]
    }
  ]
}

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 allowed to manage keys, or asking for a key to do it

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