Skip to content
Catalyzed Docs

List jobs (system admin only)

GET
/jobs

List background jobs with optional filtering by status, task type, and date range. Requires system admin access.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
taskType
string
status
string
Allowed values: pending claimed running succeeded failed cancelled
workerId
string
createdAfter
string format: date-time
createdBefore
string format: date-time
page
number
>= 1
pageSize
number
>= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Jobs retrieved successfully

object
jobs
required
Array<object>
object
id
required
string
taskType
required
string
payload
nullable
result
nullable
status
required
string
Allowed values: pending claimed running succeeded failed cancelled
affinityTags
required
Array<string>
workerId
required
string
nullable
leaseExpiresAt
required
string format: date-time
nullable
heartbeatAt
required
string format: date-time
nullable
attempt
required
number
maxAttempts
required
number
errorMessage
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
completedAt
required
string format: date-time
nullable
total
required
number
page
required
number
pageSize
required
number

403

Section titled “403 ”

Forbidden - system admin access required

object
error
required
string
code
string