API reference · Calendar Events
List calendar event instances
GET/v1/calendar-event-instances
List all calendar event instances.
Requires a Bearer access token.
Parameters
limit#numberin queryThe max number of items to return.
cursor#stringin queryThe id of the last item from the previous page. Used to fetch the next page.
startDate_lt#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
startDate_lte#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
startDate_gt#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
startDate_gte#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
endDate_lt#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
endDate_lte#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
endDate_gt#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
endDate_gte#string (date-time)in queryFormat: YYYY-MM-DDTHH:MM:SSZ.
language#stringin queryGet details in a specific language.
frencountry#stringin queryFilter for a given country. ISO 3166-1 alpha-2 code. If not specified, only international events will be returned.
calendarEventId#stringin queryUUIDGet instances of a specific event.
charityId#stringin queryUUIDGet instances for a specific charity.
Response
200 · LocalizedCalendarEventInstance[]No field is described in the spec.
calendarEventInstanceId#stringalways returnedslug#stringalways returnededition#stringalways returnedstartDate#string (date-time)always returnedendDate#string (date-time)always returnedcalendarEventId#stringalways returnedcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returnedname#stringalways returnedcountries#string[]always returnedcharities#LightCharity[]always returned3 child fields
charityIdstringalways returnednamestringalways returnedlogoUrlstringalways returned
Errors
400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }
curl -X GET https://api.sandbox.charitips.com/v1/calendar-event-instances \ -H "Authorization: Bearer $CHARITIPS_TOKEN"Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.