GET
/
v1
/
calendars
/
{id}
curl --request GET \
  --url https://api.chronhq.com/v1/calendars/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "CmrdZWG5MkGEn7K4gA1f9VGV2B",
  "active": true,
  "created": "2022-08-24T14:15:22Z",
  "description": "Netball is the biggest team sport in Australia",
  "image": "https://netball.com.au/public/2023-08/0p7a9429.jpg",
  "name": "2024 Australian Netball Championship",
  "object": "calendar",
  "updated": "2023-08-24T14:15:22Z",
  "url": "https://netball.com.au/anc/matchcentre"
}

Authorizations

Authorization
string
headerrequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

id
string
required

The identifier of the calendar which will be returned.

Maximum length: 5000

Response

200 - application/json

Calendars describe the specific calendars available to your customers. Calendars are populated with Events.

active
boolean

Whether the calendar is currently available for use.

created
string

Time at which the object was created, in ISO 8601 format.

description
string | null

The calendar's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the calendar for your own rendering purposes.

Maximum length: 5000
id
string

Unique identifier for the object.

Maximum length: 5000
image
string

An URL of an image for this calendar, meant to be displayable to the customer.

Maximum length: 5000
name
string

The calendar's name, meant to be displayable to the customer.

Maximum length: 5000
object
enum<string>

String representing the object's type. Objects of the same type share the same value.

Available options:
calendar
updated
string

Time at which the object was last updated, in ISO 8601 format.

url
string | null

A URL of a publicly-accessible webpage for this calendar.

Maximum length: 2048