Get jobs

Returns a paginated list of jobs for the current organization, each row carrying the job ID that per-job operations require.
Regular users see only their own jobs. Admins see all user-initiated jobs, and system-scheduled background jobs only when includeSystemJobs=true.
Rows carry no job parameters and no logs.

Query Params
string

Sort expression for ordering results.

Format:
field:direction,otherField:direction

Directions: asc, desc, ascending, descending — defaults to ascending when omitted

Fields (names are matched case-insensitively):
action, cancellationRequested, cancellationRequestedAt, completedAt, createdAt, currentStep, errorCode, id, initiatedBy, initiationType, jobType, parentJobId, progress, retryOfJobId, retryRequestedBy, startedAt, status, targetResource, targetResourceName

Default when omitted: createdAt:desc.

string
length ≤ 512

Filter expression for filtering results.

Supports JSON and RQL formats:

  • JSON: {"and":[{"field":"status","op":"eq","value":"Active"},{"field":"name","op":"ct","value":"Smith, John"}]}
  • RQL: and(eq(status,Active),ct(name,Smith%2C%20John)) — values are URL-decoded; encode reserved characters

Operators:
and, or, not (logical); eq, neq, ct, nct, sw, nsw, ew, new, gt, gte, lt, lte (predicate)

Fields (names are matched case-insensitively):
action, cancellationRequested, cancellationRequestedAt, completedAt, createdAt, currentStep, errorCode, id, initiatedBy, initiationType, jobType, parentJobId, progress, retryOfJobId, retryRequestedBy, startedAt, status, targetResource, targetResourceName

int32
1 to 2147483647

The page number to retrieve (1-based). Default: 1.

int32
1 to 100

The number of items per page (1-100). Default: 50.

boolean
Defaults to false

Whether to include system-scheduled background jobs (admin-only, default: false).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json