Intervals Developers
API Reference
Sign inGet API key
IntroductionAuthenticationErrorsPaginationRate LimitsIdempotency

Endpoints

GETYour organizationGETAll eventsGETRetrieve an eventPOSTCreate an eventGETAll registrationsPOSTRegister a participantGETAll recurrencesGETAll groupsGETRetrieve a groupGETEvents in a group
Changelog
Sign inGet API key

Endpoints

All recurrences

Retrieve a list of recurrence schedules attached to your organization's events. A recurrence describes how a parent event repeats (weekly tempo, monthly long run, etc.) and is the source of truth for auto-publishing future event runs.

GET/recurrences
curl -H "Authorization: Bearer INTERVALS_PARTNER_API_KEY" \
  https://api.intervals.run/recurrences?status=active&limit=20

Query Parameters

limitnumber

Maximum number of recurrences to return (1-100)

statusenum<string>

Filter by lifecycle status

Available options: active,paused,archived

Authorization

read:recurrences

Response

_idstringrequired

Recurrence ID

eventIdstringrequired

Parent event ID

labelstring

Human-readable label (e.g. 'Tuesday tempo')

scheduleobjectrequired

Recurrence schedule

defaultCourseIdstring

Default course ID for this cadence

statusenum<string>required

Lifecycle status

Available options: active,paused,archived

autoPublishHorizonWeeksnumber

Weeks ahead to auto-publish event runs

{
  "data": [
    {
      "_id": "rc91abc234def567",
      "eventId": "e72tuv901wxy234",
      "label": "Tuesday tempo",
      "schedule": {
        "frequency": "weekly",
        "daysOfWeek": [
          2
        ],
        "startTime": "18:30",
        "durationMinutes": 60
      },
      "status": "active",
      "autoPublishHorizonWeeks": 8
    }
  ]
}
Register a participantAll groups

Request

curl -H "Authorization: Bearer INTERVALS_PARTNER_API_KEY" \
  https://api.intervals.run/recurrences?status=active&limit=20

Response

{
  "data": [
    {
      "_id": "rc91abc234def567",
      "eventId": "e72tuv901wxy234",
      "label": "Tuesday tempo",
      "schedule": {
        "frequency": "weekly",
        "daysOfWeek": [
          2
        ],
        "startTime": "18:30",
        "durationMinutes": 60
      },
      "status": "active",
      "autoPublishHorizonWeeks": 8
    }
  ]
}