Skip to content
CM Box Documentation

List jobs in queue

GET
/api/queue/{name}/jobs
curl --request GET \
  --url 'https://example.com/api/queue/conversion/jobs?jobState=completed&start=0&limit=100' \
  --header 'Authorization: Bearer <token>'

Retrieves jobs from a specific queue. Filter by job state using query parameters.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required

Queue name

string
Example
conversion

Query Parameters

Section titled “Query Parameters”
jobState

Filter by job state

string
Allowed values: completed failed waiting active delayed
start

Start index for pagination

string
Example
0
limit

Maximum number of jobs to return

string
Example
100

Responses

Section titled “Responses”

200

Section titled “200”

Jobs retrieved successfully

Media typeapplication/json
object
count
required

Total number of jobs matching the query

integer
jobs
required

Array of queue jobs

Array<object>
object
queue
required

Queue information

object
name
required

Queue name

string
name
required

Job name

string
data

Job data payload

opts
required

Job options

object
attempts
required

Number of retry attempts

number
delay

Delay before job execution (ms)

number
id
required

Unique job ID

string
progress

Job progress information

returnvalue

Job return value after completion

delay
required

Current delay value (ms)

number
priority
required

Job priority

number
attemptsStarted
required

Number of attempts started

number
attemptsMade
required

Number of attempts completed

number
stalledCounter
required

Number of times job was stalled

number
timestamp
required

Job creation timestamp

number
queueQualifiedName
required

Fully qualified queue name

string
finishedOn

Timestamp when job finished

number
processedOn

Timestamp when job was processed

number
failedReason

Reason for job failure

string
Examplegenerated
{
  "count": 1,
  "jobs": [
    {
      "queue": {
        "name": "example"
      },
      "name": "example",
      "data": "example",
      "opts": {
        "attempts": 1,
        "delay": 1
      },
      "id": "example",
      "progress": "example",
      "returnvalue": "example",
      "delay": 1,
      "priority": 1,
      "attemptsStarted": 1,
      "attemptsMade": 1,
      "stalledCounter": 1,
      "timestamp": 1,
      "queueQualifiedName": "example",
      "finishedOn": 1,
      "processedOn": 1,
      "failedReason": "example"
    }
  ]
}