List Queue Jobs
curl --request GET \
--url https://api.example.com/queue/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/queue/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/queue/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/queue/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/queue/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/queue/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/queue/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"component_type": "<string>",
"component_id": "<string>",
"session_id": "<string>",
"status": "<string>",
"job_type": "run",
"user_id": "<string>",
"payload": {},
"attempt": 0,
"max_attempts": 1,
"idempotency_key": "<string>",
"available_at": 123,
"locked_by": "<string>",
"locked_at": 123,
"error": "<string>",
"created_at": 123,
"updated_at": 123,
"completed_at": 123
}
],
"meta": {
"page": 0,
"limit": 20,
"total_pages": 0,
"total_count": 0,
"search_time_ms": 0
}
}{
"detail": "Bad request",
"error_code": "BAD_REQUEST"
}{
"detail": "Unauthenticated access",
"error_code": "UNAUTHENTICATED"
}{
"detail": "Not found",
"error_code": "NOT_FOUND"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Internal server error",
"error_code": "INTERNAL_SERVER_ERROR"
}Queue
List Queue Jobs
List job queue jobs, optionally filtered by status. Repeat the status param to match any of several (e.g. status=failed&status=cancelled for the requeueable set; status=failed alone is the dead-letter list). Useful sort_by fields: created_at (default), updated_at, completed_at, status, attempt, component_type, component_id, user_id. Unknown sort fields are ignored.
GET
/
queue
/
jobs
List Queue Jobs
curl --request GET \
--url https://api.example.com/queue/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/queue/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/queue/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/queue/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/queue/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/queue/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/queue/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"component_type": "<string>",
"component_id": "<string>",
"session_id": "<string>",
"status": "<string>",
"job_type": "run",
"user_id": "<string>",
"payload": {},
"attempt": 0,
"max_attempts": 1,
"idempotency_key": "<string>",
"available_at": 123,
"locked_by": "<string>",
"locked_at": 123,
"error": "<string>",
"created_at": 123,
"updated_at": 123,
"completed_at": 123
}
],
"meta": {
"page": 0,
"limit": 20,
"total_pages": 0,
"total_count": 0,
"search_time_ms": 0
}
}{
"detail": "Bad request",
"error_code": "BAD_REQUEST"
}{
"detail": "Unauthenticated access",
"error_code": "UNAUTHENTICATED"
}{
"detail": "Not found",
"error_code": "NOT_FOUND"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Internal server error",
"error_code": "INTERNAL_SERVER_ERROR"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Status filter; repeatable to match any of several statuses
Number of jobs to return per page
Required range:
1 <= x <= 1000Page number for pagination
Required range:
x >= 1Field to sort jobs by
Sort order (asc or desc)
Available options:
asc, desc