StationListResponse

The paged station list returned by GET /station and GET /placement/{placement_id}/station.

successbooleanrequired

Always true on this payload.

Example: true

stations object[]required

The stations on this page.

Array [

idstringrequired

The station id. Numeric, but always serialized as a string. This value changes with the 'placement id', and so should not be persisted - use the uuid property instead.

Example: 727

namestringrequired

The station's display name.

Example: Pop Rock

on_demandintegerrequired

Whether the station is an on-demand station: 1 for yes, 0 for no.

Possible values: [0, 1]

pre_gainnumbernullablerequired

Station-level gain adjustment in dB, to be applied before playback. null when the station has no adjustment configured.

options objectrequired

Free-form, customer-configured options attached to a station. Contents vary per customer; unknown keys should be passed through rather than rejected.

crossfade_secondsnumber

Crossfade duration for the station, in seconds.

property name*any

Free-form, customer-configured options attached to a station. Contents vary per customer; unknown keys should be passed through rather than rejected.

uuidstringrequired

The station's stable external identifier. Unlike id, it does not change over time.

Example: FgT1_Yzvr_e05ANk2uCYdZi

crossfade_secondsnumbernullablerequired

The station's own crossfade duration in seconds. null when unset. This may differ from the customer-configured options.crossfade_seconds; the two can disagree.

single_playbooleanrequired

true when the station is a single-play station — one track, not a continuous stream.

last_updateddate-timerequired

When the station's contents last changed. Clients use this to decide whether a cached offline copy is stale.

last_play_startdate-time

When this client last started a play on this station. Emitted only when such a play exists, so it is absent for new clients and for stations the client has never played.

expire_datedate-time

When a downloaded offline copy of this station should be considered expired — three weeks from the moment of the response. Emitted only for entries in offline_stations on the session response; it never appears on streaming stations, nor on the station-list routes even when those are listing offline stations.

country_inclusion_modestring

How the countries list should be read: include means the station is available only in those countries, exclude means it is available everywhere but those.

Example: include

countriesstring[]

Two-letter ISO 3166-1 alpha-2 country codes the country_inclusion_mode applies to. Emitted only when country_inclusion_mode is exactly include or exclude, and never null in that case — when the property is present it always carries the list. Absent for any other mode.

]

totalintegerrequired

Total number of stations matching the query, across all pages.

pageintegerrequired

The zero-based page index that was returned, echoing the page query parameter (default 0).

per_pageintegerrequired

The page size that was applied, echoing the per_page query parameter (default 20).

StationListResponse

{
  "success": true,
  "stations": [
    {
      "id": "727",
      "name": "Pop Rock",
      "on_demand": 0,
      "pre_gain": 0,
      "options": {
        "crossfade_seconds": 0
      },
      "uuid": "FgT1_Yzvr_e05ANk2uCYdZi",
      "crossfade_seconds": 0,
      "single_play": true,
      "last_updated": "2024-07-29T15:51:28.071Z",
      "last_play_start": "2024-07-29T15:51:28.071Z",
      "expire_date": "2024-07-29T15:51:28.071Z",
      "country_inclusion_mode": "include",
      "countries": [
        "US"
      ]
    }
  ],
  "total": 0,
  "page": 0,
  "per_page": 0
}