Skip to content

Read the mobile-editable answering-policy schedule

GET
/v1/mobile/receptionist/numbers/{number_id}/schedule
curl --request GET \
--url https://api.vocapable.com/v1/mobile/receptionist/numbers/example/schedule \
--header 'Authorization: Bearer <token>'
number_id
required
Number Id
string

Successful Response

Media typeapplication/json
AnsweringPolicySchedule

The independently editable calendar portion of an answering policy.

object
policy_id
required
Policy Id
string
phone_number_id
required
Phone Number Id
string
timezone
required
Timezone
string
business_hours
Business Hours
object
key
additional properties
Array<object>
CallingWindow

One local-time window on one weekday.

object
start
required
Start
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
End
string
/^([01]\d|2[0-3]):[0-5]\d$/
holiday_dates
Holiday Dates
Array<string>
version
required
Version
integer
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
"policy_id": "example",
"phone_number_id": "example",
"timezone": "example",
"business_hours": {
"additionalProperty": [
{
"start": "example",
"end": "example"
}
]
},
"holiday_dates": [
"2026-04-15"
],
"version": 1,
"updated_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}