Skip to content

A request to be let in, and what followed

GET
/console/support-requests/{id}
curl --request GET \
--url https://example.com/console/support-requests/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
--cookie bottle.session_token=<bottle.session_token>

Who asked and why, the answer and who gave it, until when the grant ran, and while it did: sessions opened and ended, changes made (listed) and pages looked at (counted).

id
required

UUID v7

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

UUID v7

The request and its timeline

Media typeapplication/json
object
request
required
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
grantUntil
required
string | null format: date-time
timeline
required
Array<object>
object
at
required
string format: date-time
kind
required
string
who
required
string | null
detail
required
string | null
viewed
required
integer
acted
required
integer
Example
{
"request": {
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"tenantId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"level": "view",
"hours": 24,
"status": "pending"
}
}

Not signed in

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

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

Not found

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

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