Skip to content
Bottle

List sign-up codes

GET
/console/signup-codes
curl --request GET \
  --url https://example.com/console/signup-codes \
  --cookie bottle.session_token=<bottle.session_token>

The codes that let somebody start a business while sign-up is by invitation.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Codes

Media typeapplication/json
object
items
required
Array<object>
object
code
required
string
note
required
string | null
maxUses
required
integer
usedCount
required
integer
expiresAt
required
string | null format: date-time
createdAt
required
string format: date-time
Examplegenerated
{
  "items": [
    {
      "code": "example",
      "note": "example",
      "maxUses": 1,
      "usedCount": 1,
      "expiresAt": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z"
    }
  ]
}

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"
    }
  ]
}