GET
/
v1
/
calendars
/
{id}
/
subscribers
curl --request GET \
  --url https://api.chronhq.com/v1/calendars/{id}/subscribers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/v1/calendars/aa3kD9wsUB5LtLlpOLMzWKpvtd/subscribers",
  "data": [
    {
      "id": "fI7AqBtWI4H44p9GlJ5uz0R0Xe",
      "active": true,
      "created": "2022-08-24T14:15:22Z",
      "email": "[email protected]",
      "first_name": "oberon",
      "last_name": "pitterson",
      "object": "subscriber",
      "updated": "2023-08-24T14:15:22Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The identifier of the calendar.

Maximum length: 5000

Query Parameters

active
boolean
default:
true

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

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