API Reference
Get Job
Get a specific job by its ID.
GET
/
v2
/
jobs
/
{job_id}
Authorizations
X-API-Key
string
headerrequiredThe Sieve API key to authenticate with.
Path Parameters
job_id
string
requiredThe ID of the job.
Query Parameters
offset
integer
default: 0Response
200 - application/json
id
string
requiredThe id of the job.
function_id
string
requiredThe id of the function that the job belongs to. This can be the first 7 characters of the full id.
function
object | null
requiredThe name of the function that the job belongs to.
status
string
requiredThe status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled'
created_at
string | null
requiredThe time the job was created.
started_at
string | null
requiredThe time the job started processing by the function.
completed_at
string | null
requiredThe time the job was completed.
inputs
object
requiredShow child attributes
outputs
array | null
requiredShow child attributes
error
string | null
requiredThe error that the job ran into. Empty string if there's no error.
visibility
string
required"public" or "private".
run_id
string | null
requiredThe run_id of the job.
children
object | null
Child attributes
restarts
object[] | null
Job restart metadata
Was this page helpful?