API reference · Studio

Studio and locations

Read the identity, branding, timezone, and permitted locations for the studio attached to the credential.

Endpoints3

Primary objectStudioObject

Tenant boundaryCredential studio

GET/studio

Retrieve the studio

Returns the studio bound to the API credential. A credential can never select another studio.

Required scope: studio:read
Success: 200
Response: StudioObject

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/studio" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "id": "8d39560b-50fd-46d1-a543-b11a3525479c",
  "object": "studio",
  "name": "JUX Studios",
  "slug": "jux-studios",
  "timezone": "America/Denver",
  "primary_color": "#111111"
}

GET/locations

List locations

Lists active and inactive locations visible to the credential. Location-restricted keys receive only permitted locations.

Required scope: studio:read
Success: 200
Response: Page<LocationObject>

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/locations" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "object": "list",
  "data": [{
    "id": "159e78c2-d0b4-44fc-995f-e0d587b42f55",
    "object": "location",
    "name": "JUX RiNo",
    "city": "Denver",
    "state": "CO",
    "timezone": "America/Denver",
    "active": true,
    "is_primary": true
  }],
  "has_more": false,
  "next_cursor": null
}

GET/locations/{location_id}

Retrieve a location

Returns one permitted studio location. Cross-studio and non-permitted identifiers both return 404.

Required scope: studio:read
Success: 200
Response: LocationObject

Parameters

location_idpathrequired

uuid

The stable ClassFlow identifier for the location.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/locations/YOUR_LOCATION_ID" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "id": "159e78c2-d0b4-44fc-995f-e0d587b42f55",
  "object": "location",
  "name": "JUX RiNo",
  "city": "Denver",
  "state": "CO",
  "timezone": "America/Denver",
  "active": true,
  "is_primary": true
}

Object schema

StudioObject

Full OpenAPI schema

iduuid

Stable studio identifier.

namestring

Studio display name.

slugstring | null

Public ClassFlow studio slug.

timezonestring | null

IANA timezone used by the studio.

logo_urlstring | null

Current studio logo URL.

primary_colorstring | null

Configured primary brand color.