Skip to main content
GET
/
ddex
/
queue
/
jobs
List DDEX queue jobs (tenant-scoped)
curl --request GET \
  --url https://api.royalti.io/ddex/queue/jobs \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "totalItems": 123,
    "jobs": [
      {
        "id": "<string>",
        "jobType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z",
        "progress": 123,
        "lastProgressMessage": "<string>"
      }
    ],
    "totalPages": 123,
    "currentPage": 123,
    "filteredItems": 123
  }
}

​
Code Examples

const response = await fetch('https://api.royalti.io/ddex/queue/jobs', {
  method: 'GET',
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20
​
size
integer
default:20
​
status
enum<string>
Available options:
pending,
running,
completed,
failed
​
jobType
string
​
workflowId
string
​
search
string
​
from
string<date-time>
​
to
string<date-time>
​
sortBy
enum<string>

Field to sort by. Defaults to createdAt.

Available options:
createdAt,
status,
startedAt,
completedAt
​
sortDir
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

Success

​
success
boolean
​
data
object