GET
/
v1
/
calendars
curl --request GET \
  --url https://api.chronhq.com/v1/calendars \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/v1/calendars",
  "data": [
    {
      "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",
      "updated": "2023-08-24T14:15:22Z",
      "url": "https://netball.com.au/anc/matchcentre"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
active
boolean
default:
true

Only return calendars that are active or inactive (e.g., pass false to list all inactive calendars).

​
limit
integer
default:
10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Response

200
application/json
Successful response.
​
data
object[]
required

Details about each object.

​
object
enum<string>
required

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

Available options:
list
​
url
string
required

The URL where this list can be accessed.

Maximum length: 5000
The calendar objectCreate a calendar