Skip to content
Bottle

Requests to be let in, across every business

GET
/console/support-requests
curl --request GET \
  --url 'https://example.com/console/support-requests?status=pending&level=view&tenantId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&order=asc&limit=25&offset=0' \
  --cookie bottle.session_token=<bottle.session_token>

A page at a time, newest first unless order=asc. q matches part of the business, the asker or the reason; the rest narrow by status, level, who asked, which business and when.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 120 characters
status
string
Allowed values: pending approved declined expired
level
string
Allowed values: view act
staffUserId
string
tenantId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

createdFrom
string format: date
createdTo
string format: date
order
string
default: desc
Allowed values: asc desc
limit
integer
default: 25 >= 1 <= 200
offset
integer | null
0 <= 100000

Responses

Section titled “Responses”

200

Section titled “200”

Requests

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

UUID v7

string format: uuid
tenantId
required

UUID v7

string format: uuid
staffUserId
required
string
staffName
required
string | null
level
required
string
Allowed values: view act
reason
required
string
hours
required
Any of:
number
Allowed values: 24
status
required
string
Allowed values: pending approved declined expired
decidedByName
required
string | null
decidedAt
required
string | null format: date-time
createdAt
required
string format: date-time
tenantName
required
string
total
required
integer
offset
required
integer
limit
required
integer
> 0
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "tenantId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "level": "view",
      "hours": 24,
      "status": "pending"
    }
  ]
}

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