List and filter jobs

GET

/api/v1/jobs/

curl --request GET \
  --url 'https://example.com/api/v1/jobs/?status=all&limit=25&offset=0&sort_by=modified_time&sort_order=desc&nexa_managed=true&include_settings=false'

List jobs with filtering, sorting and pagination from database.

Status Filters: ‘all’, ‘failed’, ‘running’, ‘succeeded’, ‘canceled’

Returns empty list if no matches found for the given filters. Pagination: use limit and offset for pagination. has_more indicates if more results available.

Parameters

Query Parameters

search

Any of:

string

string

null

null

Search in job names (case-insensitive substring match) or by exact job ID

status

Status

Filter by job status: all, failed, running, succeeded, canceled

string

default: all

Filter by job status: all, failed, running, succeeded, canceled

limit

Limit

Number of jobs to return per page

integer

default: 25 >= 1 <= 100

Number of jobs to return per page

offset

Offset

Pagination offset

integer

0

Pagination offset

sort_by

Sort By

Sort by: job_name, modified_time, created_time

string

default: modified_time

Sort by: job_name, modified_time, created_time

sort_order

Sort Order

Sort order: asc, desc

string

default: desc

Sort order: asc, desc

nexa_managed

Any of:

boolean

boolean

null

null

Filter by Nexa-managed jobs (tags.nexa_managed=true/false). Default true.

include_settings

Include Settings

Include full job settings/tasks in response

boolean

Include full job settings/tasks in response

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

JobsListResponse

Response model for a list of jobs.

object

jobs

required

Jobs

Array<object>

JobListItem

Refined job list item with simplified status.

object

job_name

required

Job Name

Name of the job

string

job_type

Any of:

string

string

null

null

job_id

required

Job Id

integer

creator_user_name

Any of:

string

string

null

null

run_as_user_name

Any of:

string

string

null

null

created_time

Any of:

string

string format: date-time

null

null

modified_time

Any of:

string

string format: date-time

null

null

is_active

Is Active

boolean

default: true

tags

Any of:

object

object

key

additional properties

string

null

null

timeout_seconds

Any of:

integer

integer

null

null

max_concurrent_runs

Any of:

integer

integer

null

null

description

Any of:

string

string

null

null

settings

Any of:

object

object

key

additional properties

any

null

null

schedule_type

Any of:

string

string

null

null

schedule_details

Any of:

object

object

key

additional properties

any

null

null

continuous_config

Any of:

object

object

key

additional properties

any

null

null

notification_settings

Any of:

object

object

key

additional properties

any

null

null

health_rules

Any of:

object

object

key

additional properties

any

null

null

trigger_state

Any of:

object

object

key

additional properties

any

null

null

budget_policy_id

Any of:

string

string

null

null

usage_policy_id

Any of:

string

string

null

null

status

required

Status

Running, succeeded, failed, canceled, never_run

string

last_run_time

Any of:

string

string format: date-time

null

null

last_run_duration

Any of:

integer

integer

null

null

last_run_lifecycle_state

Any of:

string

string

null

null

last_run_result_state

Any of:

string

string

null

null

duration_delta

Any of:

string

string

null

null

nexa_managed

Nexa Managed

boolean

job_url

Any of:

string

string

null

null

stats

required

DashboardStats

Statistics for the support dashboard.

object

total_jobs

required

Total Jobs

integer

jobs_running

required

Jobs Running

integer

jobs_failed

required

Jobs Failed

integer

jobs_needing_attention

required

Jobs Needing Attention

integer

attention_list

Attention List

Array<object>

object

key

additional properties

any

total_count

required

Total Count

integer

has_more

required

Has More

boolean

limit

Limit

integer

offset

Offset

integer

status

Status

string

default: success

Example

{
  "jobs": [
    {
      "is_active": true,
      "nexa_managed": false
    }
  ],
  "status": "success"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}