List channels

GET

/v1/channels

const url = 'https://api.keliplay.com/v1/channels';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.keliplay.com/v1/channels \
  --header 'Authorization: Bearer <token>'

Lists every channel, oldest first, with a summary of what each one is running.

Permission: campaigns.read.

Authorizations

apiKey

Responses

200

Your channels.

application/json

object

channels

required

Array

A channel with a summary of what it runs.

object

required

string

name

required

string

status

required

string

Allowed values: active disabled

betweenCampaigns

required

One of:

object
null

What the channel shows when no campaign is live.

object

title

string

<= 120 characters

body

string

<= 600 characters

imageUrl

An https URL, or a file from your media library.

string

<= 2048 characters

maxPlaysPerParticipant

required

Plays allowed per player across every campaign on this channel.

integer | null

maxPlaysPerParticipantPerDay

required

Plays allowed per player per day across every campaign on this channel.

integer | null

playLimitTimezone

required

string

createdAt

required

string format: date-time

updatedAt

string format: date-time

campaignCount

required

integer

gameCount

required

How many different games the channel’s campaigns use.

integer

liveCampaignId

The campaign live now, if any.

string | null

liveCampaignName

string | null

liveCampaignUntil

string | null format: date-time

previewGameSlug

The game to show for this channel. The live campaign’s, else the next to start, else the newest.

string | null

previewCampaignName

string | null

previewCampaignStatus

One of:

string
null

draft: being set up. Players cannot see it.
active: live on its channel, during its live window.
paused: hidden for now. Plays and results are kept.
archived: finished and put away. Can be restored.

string

Allowed values: draft active paused archived

nextLiveFrom

When the next scheduled campaign starts.

string | null format: date-time

Example

{
  "channels": [
    {
      "id": "0192f3a1-0000-7000-8000-00000000c001",
      "name": "Homepage banner",
      "status": "active",
      "betweenCampaigns": {
        "title": "Back soon",
        "body": "Our next game starts on Monday."
      },
      "maxPlaysPerParticipant": null,
      "maxPlaysPerParticipantPerDay": 3,
      "playLimitTimezone": "Europe/London",
      "createdAt": "2026-09-01T09:00:00.000Z",
      "campaignCount": 2,
      "gameCount": 1,
      "liveCampaignId": "0192f3a1-0000-7000-8000-0000000ca001",
      "liveCampaignName": "Autumn wheel",
      "liveCampaignUntil": "2026-10-31T23:59:59.000Z",
      "previewGameSlug": "spin-wheel",
      "previewCampaignName": "Autumn wheel",
      "previewCampaignStatus": "active",
      "nextLiveFrom": null
    }
  ]
}

401

The API key is missing, malformed or revoked.

application/json

object

error

required

object

code

required

Stable and safe to branch on.

invalid_request (400): the request is not valid.
unauthorized (401): missing, malformed or revoked API key.
upgrade_required (402): not in your plan, or a plan limit is reached.
forbidden (403): the key lacks a permission, or the action is not allowed.
not_found (404): nothing with that id in your account.
conflict (409): clashes with the current state.
confirmation_required (409): repeat with confirm=true. Folder deletion only.
rate_limited (429): wait for Retry-After seconds.
internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>
object

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

403

The API key does not carry the permission this needs, or the request is not allowed.

application/json

object

error

required

object

code

required

Stable and safe to branch on.

invalid_request (400): the request is not valid.
unauthorized (401): missing, malformed or revoked API key.
upgrade_required (402): not in your plan, or a plan limit is reached.
forbidden (403): the key lacks a permission, or the action is not allowed.
not_found (404): nothing with that id in your account.
conflict (409): clashes with the current state.
confirmation_required (409): repeat with confirm=true. Folder deletion only.
rate_limited (429): wait for Retry-After seconds.
internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>
object

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

Example

{
  "error": {
    "code": "forbidden",
    "message": "Your role does not allow this (draws.run)."
  }
}