GET
/
v1
/
events
curl --request GET \
  --url https://api.chronhq.com/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/v1/events",
  "data": [
    {
      "id": "om6kxwlbB91pPZrhIwaNTusXjT",
      "active": true,
      "created": "2022-08-24T14:15:22Z",
      "description": "Can the Wild tame the Victorians at home?",
      "end": "2023-10-31T17:30:00",
      "location": "Blundstone Arena\\n15 Derwent St\\, Bellerive TAS 7018\\, Australia",
      "name": "Tasmania Wild vs Victorian Fury",
      "object": "event",
      "calendar": "26tbz5q3syTZK2zDBGwboz7AiA",
      "start": "2023-10-31T15:00:00",
      "updated": "2023-08-24T14:15:22Z",
      "url": "https://netball.com.au/anc/matchcentre/tas-wild-vic-fury"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

active
boolean
default:
true

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

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