Skip to main content
GET

Query Parameters

id
string<uuid>[]

If provided, will only return jobs whose UUID matches the list provided.

UUID of a job

status
enum<string>

If provided, will only return jobs whose status matches the one provided. Status of a job.

Available options:
submitted,
ready,
running,
canceled,
completed,
failed
Example:

"completed"

submitter_id
string

If provided, will only return jobs from a project you belong to where the jobs belong to the specified user ID also in that project. This parameter is ignored if not a part of the associated project specified by project_id.

project_id
string<uuid>

If provided, will only return jobs associated with the UUID of a project you belong to.

limit
integer
default:25

How many objects to return.

Required range: 1 <= x <= 25
next
string<uuid>

ID of next batch of resources to load.

Response

200 - application/json

Successfully retrieved a list of jobs.

Response body when requesting all or many jobs.

jobs
object[]

A list of jobs.

next
string<uuid>

ID of next batch of resources to load.