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/v1/partner/eventsScopes
Each API key is granted one or more scopes that determine which endpoints it can access.
| Scope | Access |
|---|---|
| read:series | List and retrieve event series |
| read:events | List and retrieve events |
| read:participants | List event participants |
| write:events | Create events |
| write:participants | Register 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 tier for development and testing without affecting production data.