Skip to main content

This page is also available as plain markdown · OpenAPI spec

List recurring schedules

GET 

/events/:eventId/recurring_schedules

List recurring schedules

Request

Path Parameters

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

200

Returns recurring schedules with decoded patterns
dataobject[]required
objectstring
idstring
eventIdstring
frequencystring
startDatestring
timestring
durationMinutesinteger
weekdaystringnullable
monthlyobjectnullable
typestringrequired
weekdaystringnullable
occurrenceintegernullable
dayOfMonthintegernullable
endsobject
typestringrequired
countintegernullable
datestringnullable
repeatUntilstring
completedAtnullable
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: returns_recurring_schedules_with_decoded_patterns
{
  "data": [
    {
      "object": "recurring_schedule",
      "id": "0c7e95d4-58b0-4a7e-9f3a-1f2b6f9f3a01",
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "frequency": "weekly",
      "startDate": "2026-06-10",
      "time": "18:00",
      "durationMinutes": 120,
      "weekday": "wednesday",
      "monthly": null,
      "ends": {
        "type": "never"
      },
      "repeatUntil": "2028-06-10",
      "completedAt": null
    },
    {
      "object": "recurring_schedule",
      "id": "7d4f2a9b-9c1e-4b5a-8e6d-2a3b4c5d6e02",
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "frequency": "monthly",
      "startDate": "2026-06-12",
      "time": "19:00",
      "durationMinutes": 90,
      "weekday": null,
      "monthly": {
        "type": "onWeekday",
        "weekday": "friday",
        "occurrence": 2
      },
      "ends": {
        "type": "after",
        "count": 10
      },
      "repeatUntil": "2027-04-12",
      "completedAt": null
    },
    {
      "object": "recurring_schedule",
      "id": "3b8c1d2e-6f4a-4c9b-a7e5-8d9f0a1b2c03",
      "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
      "frequency": "monthly",
      "startDate": "2026-06-15",
      "time": "10:30",
      "durationMinutes": 60,
      "weekday": null,
      "monthly": {
        "type": "onDate",
        "dayOfMonth": 15
      },
      "ends": {
        "type": "on",
        "date": "2026-12-15"
      },
      "repeatUntil": "2026-12-15",
      "completedAt": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 3,
  "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"
  }
}