Get a calendar

GET

/api/v1/calendars/{id}

const url = 'https://digize.com/api/v1/calendars/example';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

One calendar with its team and booking rules.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

>= 1 characters <= 64 characters

Responses

200

Done

application/json

object

required

string

name

required

string

slug

required

Its booking page’s address after the workspace’s.

string

description

required

string

color

required

string

Allowed values: violet orange teal blue amber pink

duration

required

In minutes.

number

price

required

Per person, in minor units.

integer

<= 100000000

deposit

required

Per person, taken through Stripe when a customer books.

integer

<= 100000000

capacity

required

The most people one booking can bring.

number

bufferMinutes

required

Kept free after each appointment.

number

noticeHours

required

How soon before it starts a time can be booked.

number

windowDays

required

How far ahead customers can book.

number

team

required

Array<object>

object

required

The team member’s user id.

string

name

required

string

roundRobin

required

Each booking goes to whoever’s free and least booked.

boolean

active

required

Whether its booking page takes bookings.

boolean

Example

{
  "color": "violet"
}

400

What was sent isn’t valid (invalid).

application/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

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

application/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

The key doesn’t have the permission this needs.

application/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

Nothing has that id (not_found).

application/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

Over the rate limit; see retry-after.

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