Skip to main content

This page is also available as plain markdown · OpenAPI spec

Get occurrence

GET 

/events/:eventId/occurrences/:id

Get occurrence

Request

Path Parameters

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

Query Parameters

    expandstring
    Example: activities

200

Returns the occurrence
objectstringrequired
idstringrequired
eventIdstringrequired
startsAtstringrequired
endsAtstringrequired
canceledbooleanrequired
createdAtstringrequired
updatedAtstringrequired
recurringScheduleIdstringnullablerequired
metaobjectrequired
requestIdstringrequired
scopeHintsobject[]
expandstring
missingScopestring
recurringScheduleobjectnullable
objectstringrequired
idstringrequired
eventIdstringrequired
frequencystringrequired
startDatestringrequired
timestringrequired
durationMinutesintegerrequired
weekdaystringrequired
monthlynullablerequired
endsobjectrequired
typestringrequired
repeatUntilstringrequired
completedAtnullablerequired
activitiesobject
objectstringrequired
urlstringrequired
dataundefined[]required
hasMorebooleanrequired
Example: returns_the_occurrence
{
  "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,
  "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 occurrence
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_occurrence
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}