Skip to content
digizeDocs

Get the booking hours

GET
/api/v1/availability
curl --request GET \
  --url https://digize.com/api/v1/availability \
  --header 'x-api-key: <x-api-key>'

The workspace’s weekly hours and date overrides, which every calendar books inside.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
weekly
required
Array<object>
object
day
required

0 is Sunday.

integer
<= 6
open
required
boolean
ranges
required

Minutes after midnight on the availability’s clock.

Array<object>
object
start
required
integer
<= 1440
end
required
integer
<= 1440
overrides
required
Array<object>
object
id
required
string
date
required

Such as 2026-11-26.

string
label
required
string
closed
required
boolean
ranges
required
Array<object>
object
start
required
integer
<= 1440
end
required
integer
<= 1440
timezone
required

The IANA time zone the hours are on.

string

Example generated

{
  "weekly": [
    {
      "day": 1,
      "open": true,
      "ranges": [
        {
          "start": 1,
          "end": 1
        }
      ]
    }
  ],
  "overrides": [
    {
      "id": "example",
      "date": "example",
      "label": "example",
      "closed": true,
      "ranges": [
        {
          "start": 1,
          "end": 1
        }
      ]
    }
  ],
  "timezone": "example"
}

400

Section titled “400”

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

401

Section titled “401”

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

403

Section titled “403”

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

404

Section titled “404”

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

429

Section titled “429”

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