---
title: "List calendar event instances"
description: "List all calendar event instances."
canonical: https://www.charitips.com/docs/api-reference/list-calendar-event-instances
---

# List calendar event instances

`GET /v1/calendar-event-instances`

List all calendar event instances.

**Authentication**: Bearer access token.

## Parameters

- `limit` (number): The max number of items to return.
- `cursor` (string): The id of the last item from the previous page. Used to fetch the next page.
- `startDate_lt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `startDate_lte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `startDate_gt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `startDate_gte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `endDate_lt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `endDate_lte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `endDate_gt` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `endDate_gte` (string (date-time)): Format: YYYY-MM-DDTHH:MM:SSZ.
- `language` (string): Get details in a specific language. One of `fr`, `en`.
- `country` (string): Filter for a given country. ISO 3166-1 alpha-2 code. If not specified, only international events will be returned.
- `calendarEventId` (string, UUID): Get instances of a specific event.
- `charityId` (string, UUID): Get instances for a specific charity.

## Response 200

- `calendarEventInstanceId` (string, required)
- `slug` (string, required)
- `edition` (string, required)
- `startDate` (string (date-time), required)
- `endDate` (string (date-time), required)
- `calendarEventId` (string, required)
- `createdAt` (string (date-time), required)
- `updatedAt` (string (date-time), required)
- `name` (string, required)
- `countries` (string[], required)
- `charities` (LightCharity[], required)
  - `charityId` (string, required)
  - `name` (string, required)
  - `logoUrl` (string, required)

## Errors

- 400 `A field is missing, has the wrong type, or is not part of the request schema.`: `message` lists every problem. Unknown fields are rejected, not ignored: remove them rather than sending extra data. See https://www.charitips.com/docs/api-reference/errors.md.
- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/calendar-event-instances \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/calendar-event-instances', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/calendar-event-instances",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
[
  {
    "calendarEventInstanceId": "<calendarEventInstanceId>",
    "slug": "<slug>",
    "edition": "<edition>",
    "startDate": "<startDate>",
    "endDate": "<endDate>",
    "calendarEventId": "<calendarEventId>",
    "createdAt": "<createdAt>",
    "updatedAt": "<updatedAt>"
  }
]
```