What can I build with this endpoint?

A landing page for a single event series, with its description and hero image — a home for every event under that series.

What are cardImageUrl and coverImageUrl for?

They're hosted, ready-to-render images for each event or collection — use cardImageUrl in a grid and coverImageUrl as a page hero, so you don't have to store or generate artwork yourself.

Endpoints

Retrieve a collection

Retrieve a single event collection by slug. Scoped to your organization.

GET/collections/:slug

curl -H "Authorization: Bearer INTERVALS_PARTNER_API_KEY" \
  https://api.intervals.run/collections/lakefront-race-series

Path Parameters

slugstringrequired

The collection slug

Authorization

read:collections

Response

idstringrequired

Collection ID

organizationIdstringrequired

Owning organization ID

namestringrequired

Collection name

slugstringrequired

URL-friendly slug (unique)

descriptionstring

Collection description

statusenum<string>required

Lifecycle status

Available options: active,paused,archived

cardImageUrlstring

Card image URL (if set).

coverImageUrlstring

Cover image URL (if set).

{
  "data": {
    "id": "c14abc789def012",
    "organizationId": "k57abc123def456",
    "name": "Lakefront Race Series",
    "slug": "lakefront-race-series",
    "description": "Our seasonal series of lakefront road races.",
    "status": "active"
  }
}

What you can build

Request

curl -H "Authorization: Bearer INTERVALS_PARTNER_API_KEY" \
  https://api.intervals.run/collections/lakefront-race-series

Response

{
  "data": {
    "id": "c14abc789def012",
    "organizationId": "k57abc123def456",
    "name": "Lakefront Race Series",
    "slug": "lakefront-race-series",
    "description": "Our seasonal series of lakefront road races.",
    "status": "active"
  }
}