Skip to main content
GET
List

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Query Parameters

limit
integer
default:50

Max items to return (1-500)

Required range: 1 <= x <= 500
offset
integer | null
default:0

Items to skip

Required range: x >= 0
sort
string

Comma-separated sort fields, prefix with - for descending. Allowed: created_at, started_at, finished_at, schedule_date, name, status, priority

status
string

Comma-separated statuses, e.g. working,pending

pool_id
string

Comma-separated pool ids

group_id
string

Comma-separated job group ids

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

user_id
string

Comma-separated user ids

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

type
string

Comma-separated step types; matches jobs with any step of one of them, e.g. 3dsmax,blender

priority_min
integer | null

Lowest priority to include

priority_max
integer | null

Highest priority to include

created_after
integer | null

Created at or after this time, in ms since the epoch

created_before
integer | null

Created before this time, in ms since the epoch

started_after
integer | null

Started at or after this time, in ms since the epoch

started_before
integer | null

Started before this time, in ms since the epoch

finished_after
integer | null

Finished at or after this time, in ms since the epoch

finished_before
integer | null

Finished before this time, in ms since the epoch

ids
string

Comma-separated job ids

Substring match on the job name

Required string length: 1 - 200
name
string

Exact job name, case-sensitive

Required string length: 1 - 200

Response

Matching jobs, without the per-task data a list never draws: each step's tasks and its task_info.*_list state ranges come back empty, because both hold one entry per task. The counts and all_list stay. Read the one job (GET /jobs/{id}), or the tasks themselves, for the rest

data
object[]
required
total
integer
required

Total matching the filter, ignoring limit/offset

limit
integer
required
offset
integer
required