Skip to content
Developers
Esc
No results found.

List Jobs

Scopes
read:job

Query Parameters

fields
string | array<string>

Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: id,created_at 

limit
number
min-1
max
500

Limit the number of results returned

Examples: 5 

offset
number
min0
max
99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

q
string

Additional query in PlusAuth Query Language format.

sort_by
string | array<string>

Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: id.asc,created_at.desc email.asc 

GET
/jobs
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Paginated list of jobs
Loading...

Response Body Schema

total
number
Required

Total number of results matching the query.

results
array<object>

Array of the paginated results matching the query.

results.
name
string
Required
length
0-256

Logical job name unique per tenant.

results.
type
string
Required

Job type

Available Values: slu

results.
end_at
string

End boundary for job schedule.

results.
max_runs
integer
min1

Maximum allowed executions for scheduled jobs.

results.
pattern
string
length
0-256

Cron pattern, seconds are not supported. Null/undefined for one-time jobs.

results.
start_at
string

Start boundary for job schedule.

results.
tz
string
length
0-64

Timezone identifier used for cron-based scheduling.

results.
metadata
object
Required

Custom metadata, input payload templates, tags, or execution options.