Skip to content
Aller au contenu
Charitips

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 query

    The max number of items to return.

  • cursor#stringin query

    The id of the last item from the previous page. Used to fetch the next page.

  • startDate_lt#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • startDate_lte#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • startDate_gt#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • startDate_gte#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • endDate_lt#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • endDate_lte#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • endDate_gt#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • endDate_gte#string (date-time)in query

    Format: YYYY-MM-DDTHH:MM:SSZ.

  • language#stringin query

    Get details in a specific language.

    fren

  • country#stringin query

    Filter for a given country. ISO 3166-1 alpha-2 code. If not specified, only international events will be returned.

  • calendarEventId#stringin queryUUID

    Get instances of a specific event.

  • charityId#stringin queryUUID

    Get instances for a specific charity.

Response

200 · LocalizedCalendarEventInstance[]

No field is described in the spec.

  • calendarEventInstanceId#stringalways returned

  • slug#stringalways returned

  • edition#stringalways returned

  • startDate#string (date-time)always returned

  • endDate#string (date-time)always returned

  • calendarEventId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

  • name#stringalways returned

  • countries#string[]always returned

  • charities#LightCharity[]always returned

    3 child fields
    • charityIdstringalways returned

    • namestringalways returned

    • logoUrlstringalways 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"
    }
GET /v1/calendar-event-instances
curl -X GET https://api.sandbox.charitips.com/v1/calendar-event-instances \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

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.