Skip to content
Keptslot
Start free

List workspaces

GET
/v1/account/workspaces
curl --request GET \
--url https://api.keptslot.com/v1/account/workspaces \
--header 'Authorization: Bearer <token>'

This endpoint lists the live workspaces of the account. A deleted workspace is not in the response.

The live workspaces of the account.

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
name
required
string
slug

The address of the booking page. It is null for a workspace that has no slug yet.

string | null
timezone
required
string
Example generated
{
"data": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"slug": "example",
"timezone": "example"
}
]
}

The key is missing, malformed or revoked.

Media type application/json
object
error
required
object
type
required

A stable machine-readable code. Match on this.

string
message
required

A sentence for a person. Do not match on this.

string
param

The field that caused the refusal, if one field did.

string
dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string
used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64
limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64
Example generated
{
"error": {
"type": "example",
"message": "example",
"param": "example",
"dimension": "example",
"used": 1,
"limit": 1
}
}