Beta

Jobs are a core part of Channels, these are the scheduled workers that will record your programs for you. On this page, we’ll dive into the different job endpoints you can use to read scheduled job information programmatically.

The job model

The job model contains all the information about your scheduled recordings, such as its content, time, potential channels, etc.

Note: Properties with null values will be ommited from the response.

Properties

id string

The unique identifier for the job.

name integer

The name of the program or Series Pass scheduled to record.

start_time timestamp

The timestamp of when the scheduled recording will begin.

end_time timestamp

The timestamp of when the scheduled recording will end.

duration integer

The duration the scheduled recording will last.

channels array

An array of strings denoting the possible channels the job will record from.

channel string

The channel the job is set to record from.

skipped boolean

Whether or not the job will be skipped.

failed boolean

Whether or not the job failed while recording.

error string

An error explaining why the recording job failed.

updated_at timestamp

The timestamp of when the job was last updated.

item Episode or Movie

The airing item that is set to record with the job.

GET /api/v1/jobs

List all jobs

Returns a list of all jobs.

Request
GET /api/v1/jobs
curl http://192.168.1.3:8089/api/v1/jobs
Response 
[{
  "id": "1677195000-231",
  "name": "NBC Nightly News With Lester Holt",
  "start_time": 1677195000,
  "end_time": 1677196800,
  "duration": 1800,
  "channels": [
    "512",
    "12.1",
    "6000"
  ],
  "skipped": false,
  "failed": false,
  "updated_at": 1677092762571,
  "item": {
    "show_id": "12308123",
    "program_id": "EP023034512646",
    "episode_number": 53,
    "title": "NBC Nightly News With Lester Holt",
    "summary": "The latest news, going beyond the headlines to see how lives are affected by the world around them.",
    "full_summary": "The latest news, going beyond the headlines to see how lives are affected by the world around them.",
    "image_url": "https://tmsimg.fancybits.co/assets/p12308123_b_h9_ag.jpg?w=720&h=540",
    "playback_time": 0,
    "original_air_date": "2023-02-23",
    "genres": [
      "News"
    ],
    "tags": [
      "CC",
      "DD 5.1",
      "HD 1080i",
      "HDTV",
      "New",
      "Stereo"
    ],
    "categories": [
      "Episode",
      "Series"
    ],
    "cast": [
      "Lester Holt"
    ],
    "watched": false,
    "favorited": false,
    "delayed": false,
    "cancelled": false,
    "corrupted": false,
    "completed": false,
    "processed": false,
    "locked": false,
    "verified": false
  },{
  "id": "5346775000-231",
  "name": "Family Feud",
  ...
}]

GET /api/v1/jobs/:id

Retrieve a job

This endpoint allows you to retrieve a job by using its unique identifier.

Required Attributes

id string

The unique identifier of the Job.

Request
GET /api/v1/jobs/1677195000-231
curl http://192.168.1.3:8089/api/v1/jobs/1677195000-231
Response 
{
  "id": "1677195000-231",
  "name": "NBC Nightly News With Lester Holt",
  "start_time": 1677195000,
  "end_time": 1677196800,
  "duration": 1800,
  "channels": [
    "512",
    "12.1",
    "6000"
  ],
  "skipped": false,
  "failed": false,
  "updated_at": 1677092762571,
  "item": {
    "show_id": "12308123",
    "program_id": "EP023034512646",
    "episode_number": 53,
    "title": "NBC Nightly News With Lester Holt",
    "summary": "The latest news, going beyond the headlines to see how lives are affected by the world around them.",
    "full_summary": "The latest news, going beyond the headlines to see how lives are affected by the world around them.",
    "image_url": "https://tmsimg.fancybits.co/assets/p12308123_b_h9_ag.jpg?w=720&h=540",
    "playback_time": 0,
    "original_air_date": "2023-02-23",
    "genres": [
      "News"
    ],
    "tags": [
      "CC",
      "DD 5.1",
      "HD 1080i",
      "HDTV",
      "New",
      "Stereo"
    ],
    "categories": [
      "Episode",
      "Series"
    ],
    "cast": [
      "Lester Holt"
    ],
    "watched": false,
    "favorited": false,
    "delayed": false,
    "cancelled": false,
    "corrupted": false,
    "completed": false,
    "processed": false,
    "locked": false,
    "verified": false
  }