Skip to content

Free times on a calendar

GET
/api/v1/calendars/{id}/slots
curl --request GET \
--url 'https://digize.com/api/v1/calendars/example/slots?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z' \
--header 'x-api-key: <x-api-key>'

The start times customers could book on a calendar between from and to (45 days at most), after the booking hours, its notice and window, appointments already booked and the team’s Google busy times.

Needs the crm:read permission.

id
required
string
>= 1 characters <= 64 characters
from
required
string format: date-time
to
required
string format: date-time
staffId
string
>= 1 characters <= 64 characters

Done

Media typeapplication/json
object
slots
required
Array<object>
object
start
required

When it starts, in ms since the epoch.

number
staff
required

Who on the team is free then.

Array<string>

Example generated

{
"slots": [
{
"start": 1,
"staff": [
"example"
]
}
]
}

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}