List Function Jobs

GET

functions

{owner_name}

{function_name}

jobs

Authorizations

X-API-Key

string

headerrequired

The Sieve API key to authenticate with.

Path Parameters

owner_name

string

required

The owner of the function.

function_name

string

required

The name of the function.

Query Parameters

limit

integer

default: 500

The maximum amount of jobs to show.

offset

integer

default: 0

Exclude the first N jobs.

status

string

default:

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled', . Leave empty to get all statuses.

Response

200 - application/json

data

object[]

required

data.id

string

required

The id of the job.

data.function_id

string

required

The id of the function that the job belongs to. This can be the first 7 characters of the full id.

data.organization_id

string

required

The ID of the organization that submitted the function.

data.function

object | null

required

The name of the function that the job belongs to.

data.status

string

required

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled'

data.created_at

string | null

required

The UTC time the job was created.

data.started_at

string | null

required

The UTC time the job started processing by the function.

data.completed_at

string | null

required

The UTC time the job was completed.

data.inputs

object

Show child attributes

data.outputs

array

Show child attributes

data.error

string | null

required

The error that the job ran into. Empty string if there's no error.

data.visibility

string

required

"public" or "private".

data.run_id

string | null

required

The run_id of the job.

data.children

object | null

Child attributes

data.restarts

object[] | null

Job restart metadata

next_offset

integer

default: -1

Was this page helpful?

Get Function Edit Function

Getting Started

Custom Functions

Advanced Features

Walkthroughs

Reference

Errors

List Function Jobs

Authorizations

Path Parameters

Query Parameters

Response