Get recurring schedule

GET 
/events/:eventId/recurring_schedules/:id

Get recurring schedule

Request

Path Parameters

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

Query Parameters

expandstring
Example: occurrences

200

Returns the recurring schedule

objectstringrequired

idstringrequired

eventIdstringrequired

frequencystringrequired

startDatestringrequired

timestringrequired

durationMinutesintegerrequired

weekdaystringrequired

monthlynullablerequired

endsobjectrequired

typestringrequired

repeatUntilstringrequired

completedAtnullablerequired

metaobjectrequired

requestIdstringrequired

occurrencesobject

objectstringrequired

urlstringrequired

dataobject[]required

objectstring

idstring

eventIdstring

startsAtstring

endsAtstring

canceledboolean

createdAtstring

updatedAtstring

recurringScheduleIdstring

hasMorebooleanrequired

Example: returns_the_recurring_schedule

{
  "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,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

Example: embeds_the_schedule's_occurrences_when_expanding_occurrences

{
  "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,
  "occurrences": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/786ee9ff-b264-432d-a700-3b2c2530f918/occurrences?recurringScheduleId=0c7e95d4-58b0-4a7e-9f3a-1f2b6f9f3a01",
    "data": [
      {
        "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"
      }
    ],
    "hasMore": 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 recurring schedule

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_for_non-existent_recurring_schedule

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}