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

API Reference

Authentication

All API requests require a Bearer token in the Authorization header. API keys are scoped to a single organization.

Getting an API key

Create an API key in your organization’s manage portal at Settings > API. Each key is assigned specific scopes that control which endpoints it can access.

Save your API key when it’s created. It won’t be shown again.

Making requests

Include your API key as a Bearer token in the Authorization header of every request.

curl -H "Authorization: Bearer INTERVALS_PARTNER_API_KEY" \
  https://api.intervals.run/events

Scopes

Each API key is granted one or more scopes that determine which endpoints it can access.

ScopeAccess
read:seriesList and retrieve event series
read:eventsList and retrieve events
read:participantsList event participants
write:eventsCreate events
write:participantsRegister participants

Environments

Your organization can generate separate API keys for production and test environments. Production keys have full access, while test keys are available on the free plan for development and testing without affecting production data.

IntroductionErrors