Guide

Generated guide operations.

GET/v1/guideRead guideread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide

Parameters

Name	In	Type
`channels`	query	`string`
`cursor`	query	`string`
`end`	query	`string`
`favorites`	query	`string`
`group`	query	`string`
`includeHidden`	query	`string`
`includeServerHidden`	query	`string`
`kind`	query	`string`
`limit`required	query	`integer`1–50
`programmes`	query	`string`
`search`	query	`string`
`sourceId`	query	`string`
`start`	query	`string`
`timezone`	query	`string`

Responses

200Successapplication/json

Example

{
  "guide": {
    "channels": [
      {
        "favorite": true,
        "generation": "string",
        "group": "string",
        "hidden": true,
        "id": "id_8h2k4q",
        "logoPath": "string",
        "mark": {
          "seed": "string",
          "text": "string"
        },
        "name": "Fargo",
        "number": "string",
        "preferenceRevision": 0,
        "programmes": [
          {}
        ],
        "provenance": "string",
        "recordAvailable": true,
        "recordUnavailableReason": "string",
        "serverHidden": true,
        "sourceId": "id_8h2k4q",
        "tuneAvailable": true,
        "tuneUnavailableReason": "string"
      }
    ],
    "days": 0,
    "end": "string",
    "nextCursor": "eyJvIjoyMH0",
    "observedAt": "2026-10-18T19:30:00Z",
    "sources": [
      {
        "availableEnd": "string",
        "availableStart": "string",
        "generation": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "provenance": "string",
        "publishedAt": "2026-10-18T19:30:00Z",
        "refreshState": "string"
      }
    ],
    "start": "string",
    "state": "string",
    "timezone": "2026-10-18T19:30:00Z",
    "viewerFence": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

guideobjectrequired
- channelsarray of objectrequired
  - favoritebooleanrequired
  - generationstringrequired
  - groupstringrequired
  - hiddenbooleanrequired
  - idstringrequired
  - logoPathstring
  - markobject
    seedstringrequired
    textstringrequired
  - namestringrequired
  - numberstringrequired
  - preferenceRevisionintegerrequired
  - programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - provenancestringrequired
  - recordAvailablebooleanrequired
  - recordUnavailableReasonstringrequired
  - serverHiddenbooleanrequired
  - sourceIdstringrequired
  - tuneAvailablebooleanrequired
  - tuneUnavailableReasonstringrequired
- daysintegerrequired
- endstringrequired
- nextCursorstringrequired
- observedAtstringrequired
- sourcesarray of objectrequired
  - availableEndstringrequired
  - availableStartstringrequired
  - generationstringrequired
  - idstringrequired
  - namestringrequired
  - provenancestringrequired
  - publishedAtstringrequired
  - refreshStatestringrequired
- startstringrequired
- statestringrequired
- timezonestringrequired
- viewerFencestringrequired
protocolVersionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide?limit=…" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/airingsRead guide airingsread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_airings

Parameters

Name	In	Type
`search`	query	`string`
`seriesId`	query	`string`
`title`	query	`string`
`channelId`	query	`string`
`sourceId`	query	`string`
`kind`	query	`string`
`start`	query	`string`
`end`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–50

Responses

200Successapplication/json

Example

{
  "airings": {
    "end": "string",
    "groups": [
      {
        "airings": [
          {}
        ],
        "key": "string",
        "title": "Fargo"
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "revision": "r12",
    "start": "string",
    "timezone": "2026-10-18T19:30:00Z",
    "today": "string",
    "viewerFence": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

airingsobjectrequired
- endstringrequired
- groupsarray of objectrequired
  - airingsarray of objectrequired
    channelobjectrequired
    favoritebooleanrequired
    generationstringrequired
    groupstringrequired
    hiddenbooleanrequired
    idstringrequired
    logoPathstring
    markobject
    seedstringrequired
    textstringrequired
    namestringrequired
    numberstringrequired
    preferenceRevisionintegerrequired
    programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
    provenancestringrequired
    recordAvailablebooleanrequired
    recordUnavailableReasonstringrequired
    serverHiddenbooleanrequired
    sourceIdstringrequired
    tuneAvailablebooleanrequired
    tuneUnavailableReasonstringrequired
    programmeobjectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - keystringrequired
  - titlestringrequired
- nextCursorstringrequired
- revisionstringrequired
- startstringrequired
- timezonestringrequired
- todaystringrequired
- viewerFencestringrequired
protocolVersionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/airings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/channelsRead guide channelsread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_channels

Parameters

Name	In	Type
`anchorChannelId`	query	`string`
`anchorProvenance`	query	`string`
`anchorSourceId`	query	`string`
`direction`	query	`string`
`favorites`	query	`string`
`group`	query	`string`
`includeHidden`	query	`string`
`includeServerHidden`	query	`string`
`kind`	query	`string`
`limit`	query	`integer`1–50
`offset`	query	`string`
`revision`	query	`string`
`search`	query	`string`
`sort`	query	`string`
`sourceId`	query	`string`
`timezone`	query	`string`

Responses

200Successapplication/json

Example

{
  "directory": {
    "channels": [
      {
        "favorite": true,
        "generation": "string",
        "group": "string",
        "hidden": true,
        "id": "id_8h2k4q",
        "logoPath": "string",
        "mark": {
          "seed": "string",
          "text": "string"
        },
        "name": "Fargo",
        "number": "string",
        "preferenceRevision": 0,
        "programmes": [
          {}
        ],
        "provenance": "string",
        "recordAvailable": true,
        "recordUnavailableReason": "string",
        "serverHidden": true,
        "sourceId": "id_8h2k4q",
        "tuneAvailable": true,
        "tuneUnavailableReason": "string"
      }
    ],
    "limit": 0,
    "offset": 0,
    "revision": "r12",
    "sources": [
      {
        "availableEnd": "string",
        "availableStart": "string",
        "generation": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "provenance": "string",
        "publishedAt": "2026-10-18T19:30:00Z",
        "refreshState": "string"
      }
    ],
    "total": 0,
    "viewerFence": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

directoryobjectrequired
- channelsarray of objectrequired
  - favoritebooleanrequired
  - generationstringrequired
  - groupstringrequired
  - hiddenbooleanrequired
  - idstringrequired
  - logoPathstring
  - markobject
    seedstringrequired
    textstringrequired
  - namestringrequired
  - numberstringrequired
  - preferenceRevisionintegerrequired
  - programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - provenancestringrequired
  - recordAvailablebooleanrequired
  - recordUnavailableReasonstringrequired
  - serverHiddenbooleanrequired
  - sourceIdstringrequired
  - tuneAvailablebooleanrequired
  - tuneUnavailableReasonstringrequired
- limitintegerrequired
- offsetintegerrequired
- revisionstringrequired
- sourcesarray of objectrequired
  - availableEndstringrequired
  - availableStartstringrequired
  - generationstringrequired
  - idstringrequired
  - namestringrequired
  - provenancestringrequired
  - publishedAtstringrequired
  - refreshStatestringrequired
- totalintegerrequired
- viewerFencestringrequired
protocolVersionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/channels" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/now-nextRead guide now-nextread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_now_next

Parameters

Name	In	Type
`kind`	query	`string`
`sourceId`	query	`string`
`group`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–50

Responses

200Successapplication/json

Example

{
  "page": {
    "channels": [
      {
        "favorite": true,
        "generation": "string",
        "group": "string",
        "hidden": true,
        "id": "id_8h2k4q",
        "logoPath": "string",
        "mark": {
          "seed": "string",
          "text": "string"
        },
        "name": "Fargo",
        "number": "string",
        "preferenceRevision": 0,
        "programmes": [
          {}
        ],
        "provenance": "string",
        "recordAvailable": true,
        "recordUnavailableReason": "string",
        "serverHidden": true,
        "sourceId": "id_8h2k4q",
        "tuneAvailable": true,
        "tuneUnavailableReason": "string"
      }
    ],
    "expiresAt": "2026-10-18T19:30:00Z",
    "limit": 0,
    "nextCursor": "eyJvIjoyMH0",
    "observedAt": "2026-10-18T19:30:00Z",
    "offset": 0,
    "revision": "r12",
    "sources": [
      {
        "availableEnd": "string",
        "availableStart": "string",
        "generation": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "provenance": "string",
        "publishedAt": "2026-10-18T19:30:00Z",
        "refreshState": "string"
      }
    ],
    "total": 0,
    "viewerFence": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

pageobjectrequired
- channelsarray of objectrequired
  - favoritebooleanrequired
  - generationstringrequired
  - groupstringrequired
  - hiddenbooleanrequired
  - idstringrequired
  - logoPathstring
  - markobject
    seedstringrequired
    textstringrequired
  - namestringrequired
  - numberstringrequired
  - preferenceRevisionintegerrequired
  - programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - provenancestringrequired
  - recordAvailablebooleanrequired
  - recordUnavailableReasonstringrequired
  - serverHiddenbooleanrequired
  - sourceIdstringrequired
  - tuneAvailablebooleanrequired
  - tuneUnavailableReasonstringrequired
- expiresAtstringrequired
- limitintegerrequired
- nextCursorstringrequired
- observedAtstringrequired
- offsetintegerrequired
- revisionstringrequired
- sourcesarray of objectrequired
  - availableEndstringrequired
  - availableStartstringrequired
  - generationstringrequired
  - idstringrequired
  - namestringrequired
  - provenancestringrequired
  - publishedAtstringrequired
  - refreshStatestringrequired
- totalintegerrequired
- viewerFencestringrequired
protocolVersionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/now-next" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/on-nowRead guide on-nowread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_on_now

Parameters

Name	In	Type
`kind`	query	`string`
`sourceId`	query	`string`
`group`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer`1–50

Responses

200Successapplication/json

Example

{
  "page": {
    "channels": [
      {
        "favorite": true,
        "generation": "string",
        "group": "string",
        "hidden": true,
        "id": "id_8h2k4q",
        "logoPath": "string",
        "mark": {
          "seed": "string",
          "text": "string"
        },
        "name": "Fargo",
        "number": "string",
        "preferenceRevision": 0,
        "programmes": [
          {}
        ],
        "provenance": "string",
        "recordAvailable": true,
        "recordUnavailableReason": "string",
        "serverHidden": true,
        "sourceId": "id_8h2k4q",
        "tuneAvailable": true,
        "tuneUnavailableReason": "string"
      }
    ],
    "expiresAt": "2026-10-18T19:30:00Z",
    "limit": 0,
    "nextCursor": "eyJvIjoyMH0",
    "observedAt": "2026-10-18T19:30:00Z",
    "offset": 0,
    "revision": "r12",
    "sources": [
      {
        "availableEnd": "string",
        "availableStart": "string",
        "generation": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "provenance": "string",
        "publishedAt": "2026-10-18T19:30:00Z",
        "refreshState": "string"
      }
    ],
    "total": 0,
    "viewerFence": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

pageobjectrequired
- channelsarray of objectrequired
  - favoritebooleanrequired
  - generationstringrequired
  - groupstringrequired
  - hiddenbooleanrequired
  - idstringrequired
  - logoPathstring
  - markobject
    seedstringrequired
    textstringrequired
  - namestringrequired
  - numberstringrequired
  - preferenceRevisionintegerrequired
  - programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - provenancestringrequired
  - recordAvailablebooleanrequired
  - recordUnavailableReasonstringrequired
  - serverHiddenbooleanrequired
  - sourceIdstringrequired
  - tuneAvailablebooleanrequired
  - tuneUnavailableReasonstringrequired
- expiresAtstringrequired
- limitintegerrequired
- nextCursorstringrequired
- observedAtstringrequired
- offsetintegerrequired
- revisionstringrequired
- sourcesarray of objectrequired
  - availableEndstringrequired
  - availableStartstringrequired
  - generationstringrequired
  - idstringrequired
  - namestringrequired
  - provenancestringrequired
  - publishedAtstringrequired
  - refreshStatestringrequired
- totalintegerrequired
- viewerFencestringrequired
protocolVersionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/on-now" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/programme-images/{generation}/{programme}Read guide imagesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_programme_image

Parameters

Name	In	Type
`generation`required	path	`string`
`programme`required	path	`string`
`ld`	query	`string`
`sd`	query	`string`
`size`	query	`string`
`w`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/programme-images/{generation}/{programme}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/guide/remindersGet guide remindersread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_reminders

Parameters

Name	In	Type	Description
`cursor`	query	`string`
`limit`	query	`integer`1–50

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "items": [
      {
        "airing": {
          "channel": {},
          "programme": {}
        },
        "due": true,
        "id": "id_8h2k4q",
        "revision": 0
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "revision": "r12"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- itemsarray of objectrequired
  - airingobjectrequired
    channelobjectrequired
    favoritebooleanrequired
    generationstringrequired
    groupstringrequired
    hiddenbooleanrequired
    idstringrequired
    logoPathstring
    markobject
    seedstringrequired
    textstringrequired
    namestringrequired
    numberstringrequired
    preferenceRevisionintegerrequired
    programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
    provenancestringrequired
    recordAvailablebooleanrequired
    recordUnavailableReasonstringrequired
    serverHiddenbooleanrequired
    sourceIdstringrequired
    tuneAvailablebooleanrequired
    tuneUnavailableReasonstringrequired
    programmeobjectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
  - duebooleanrequired
  - idstringrequired
  - revisionintegerrequired
- nextCursorstringrequired
- revisionstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/reminders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/guide/remindersPut guide remindersplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: put_guide_reminders
Max body: 4 KiB

Request body application/json · required

Example

{
  "channelId": "id_8h2k4q",
  "expectedRevision": 0,
  "generation": "string",
  "kind": "string",
  "programmeId": "id_8h2k4q",
  "sourceId": "id_8h2k4q"
}

Schema

channelIdstringrequired
expectedRevisionintegerrequired
generationstringrequired
kindstringrequired
programmeIdstringrequired
sourceIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "airing": {
      "channel": {
        "favorite": true,
        "generation": "string",
        "group": "string",
        "hidden": true,
        "id": "id_8h2k4q",
        "logoPath": "string",
        "mark": {
          "seed": "string",
          "text": "string"
        },
        "name": "Fargo",
        "number": "string",
        "preferenceRevision": 0,
        "programmes": [
          {}
        ],
        "provenance": "string",
        "recordAvailable": true,
        "recordUnavailableReason": "string",
        "serverHidden": true,
        "sourceId": "id_8h2k4q",
        "tuneAvailable": true,
        "tuneUnavailableReason": "string"
      },
      "programme": {
        "categories": [
          "string"
        ],
        "channelId": "id_8h2k4q",
        "description": "string",
        "end": "string",
        "episode": {
          "display": "string",
          "number": 0,
          "season": 0
        },
        "episodeId": "id_8h2k4q",
        "flags": {
          "live": true,
          "new": true,
          "premiere": true,
          "repeat": true
        },
        "id": "id_8h2k4q",
        "image": "string",
        "lineage": "string",
        "newEvidence": "string",
        "rating": {
          "system": "string",
          "value": "string"
        },
        "recordingId": "id_8h2k4q",
        "recordingState": "string",
        "seriesId": "id_8h2k4q",
        "starRating": "string",
        "start": "string",
        "subtitle": "Fargo",
        "title": "Fargo",
        "year": 0
      }
    },
    "due": true,
    "id": "id_8h2k4q",
    "revision": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- airingobjectrequired
  - channelobjectrequired
    favoritebooleanrequired
    generationstringrequired
    groupstringrequired
    hiddenbooleanrequired
    idstringrequired
    logoPathstring
    markobject
    seedstringrequired
    textstringrequired
    namestringrequired
    numberstringrequired
    preferenceRevisionintegerrequired
    programmesarray of objectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
    provenancestringrequired
    recordAvailablebooleanrequired
    recordUnavailableReasonstringrequired
    serverHiddenbooleanrequired
    sourceIdstringrequired
    tuneAvailablebooleanrequired
    tuneUnavailableReasonstringrequired
  - programmeobjectrequired
    categoriesarray of stringrequired
    channelIdstringrequired
    descriptionstring
    endstringrequired
    episodeobject
    displaystring
    numberinteger
    seasoninteger
    episodeIdstring
    flagsobjectrequired
    livebooleanrequired
    newbooleanrequired
    premierebooleanrequired
    repeatbooleanrequired
    idstringrequired
    imagestring
    lineagestringrequired
    newEvidencestring
    ratingobject
    systemstringrequired
    valuestringrequired
    recordingIdstring
    recordingStatestring
    seriesIdstring
    starRatingstring
    startstringrequired
    subtitlestring
    titlestringrequired
    yearinteger
- duebooleanrequired
- idstringrequired
- revisionintegerrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/guide/reminders" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"id_8h2k4q","expectedRevision":0,"generation":"string","kind":"string","programmeId":"id_8h2k4q","sourceId":"id_8h2k4q"}'

DELETE/v1/guide/reminders/{id}Delete guide remindersplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: delete_guide_reminders_id
Max body: 4 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0
}

Schema

expectedRevisionintegerrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "key": true
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/guide/reminders/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0}'

GET/v1/guide/sourcesRead guide sourcesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_guide_sources

Parameters

Name	In	Type
`includeHidden`	query	`string`
`includeServerHidden`	query	`string`
`timezone`	query	`string`

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "revision": "r12",
  "serverId": "id_8h2k4q",
  "sources": [
    {
      "availableEnd": "string",
      "availableStart": "string",
      "channelCount": 0,
      "favoriteCount": 0,
      "generation": "string",
      "groupCounts": [
        {
          "count": 0,
          "name": "Fargo"
        }
      ],
      "groups": [
        "string"
      ],
      "guideDays": 0,
      "id": "id_8h2k4q",
      "name": "Fargo",
      "position": 0,
      "provenance": "string",
      "publishedAt": "2026-10-18T19:30:00Z",
      "recordAvailable": true,
      "refreshState": "string",
      "unavailableReasons": {
        "key": 0
      }
    }
  ],
  "viewerFence": "string"
}

Schema

protocolVersionstringrequired
revisionstringrequired
serverIdstringrequired
sourcesarray of objectrequired
- availableEndstringrequired
- availableStartstringrequired
- channelCountintegerrequired
- favoriteCountintegerrequired
- generationstringrequired
- groupCountsarray of objectrequired
  - countintegerrequired
  - namestringrequired
- groupsarray of stringrequired
- guideDaysintegerrequired
- idstringrequired
- namestringrequired
- positionintegerrequired
- provenancestringrequired
- publishedAtstringrequired
- recordAvailablebooleanrequired
- refreshStatestringrequired
- unavailableReasonsobjectrequired
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/guide/sources" \
  -H "Authorization: Bearer $PORTICO_API_KEY"