Skip to main content

This page is also available as plain markdown · OpenAPI spec

List occurrences

GET 

/events/:eventId/occurrences

List occurrences

Request

Path Parameters

    eventIdstringrequired
    Example: 00000000-0000-0000-0000-000000000000

Query Parameters

    pageinteger
    Example: 1
    perPageinteger
    Example: 1
    recurringScheduleIdstring
    Example: nonexistent

200

Returns occurrences for the event
dataobject[]required
objectstring
idstring
eventIdstring
startsAtstring
endsAtstring
canceledboolean
createdAtstring
updatedAtstring
recurringScheduleIdstringnullable
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: returns_occurrences_for_the_event
{
  "data": [
    {
      "object": "occurrence",
      "id": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "startsAt": "2025-06-11T18:00:00Z",
      "endsAt": "2025-06-11T20:00:00Z",
      "canceled": false,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "recurringScheduleId": null
    },
    {
      "object": "occurrence",
      "id": "4b34a47d-6204-4454-982e-79c0c0533646",
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "startsAt": "2025-06-12T18:00:00Z",
      "endsAt": "2025-06-12T20:00:00Z",
      "canceled": false,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "recurringScheduleId": "0c7e95d4-58b0-4a7e-9f3a-1f2b6f9f3a01"
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent event
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_event
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}