Skip to content
Keptslot
Start free

List weekly hours

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

This endpoint gives the weekly hours of every ACTIVE calendar in one call. An inactive calendar is not in the response.

Use it instead of one request per calendar.

The weekly hours, grouped by calendar.

Media type application/json
object
data
required
Array<object>
object
staff_id
required
string format: uuid
working_hours
required
Array<object>
object
weekday
required

The day of the week. 0 is Sunday.

integer
start_minute
required

Minutes after midnight, in the workspace timezone.

integer
end_minute
required

Minutes after midnight, in the workspace timezone.

integer
Example generated
{
"data": [
{
"staff_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"working_hours": [
{
"weekday": 1,
"start_minute": 1,
"end_minute": 1
}
]
}
]
}

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