Get queue
GET
/v1/queue
One action-first list of everything in flight across all of the signed-in user's books — queued, processing, or failed. This is what a dashboard polls for a live view of "what's happening right now."
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Responses
OK
application/json
The failure reason — set only for QueueItemKind.Failed.
The backing job id when this row derives from a job (Queued / Processing / Failed).
Format
"uuid"Which bucket this row falls in (and its sort priority).
Valid values
"Failed""Processing""Queued"Human-readable progress note from the job (e.g. "Processed 5 page(s)"), when present.
The project this row belongs to (the deep-link target).
Format
"uuid"The project's name, for display.
The job's persisted dispatch position for QueueItemKind.Queued rows — the order the
processor will run them in, and the key the drag-to-reorder UI rearranges. null
for the non-queued kinds.
Format
"int64"Pattern
"^-?(?:0|[1-9]\\d*)$"When this row last changed (UTC) — drives newest-first ordering within a kind.
Format
"date-time"