Skip to content

List queues

Last updated 

GET /spools/{spool}/queues

One name-ordered page of the spool's queues, each with its settings and a snapshot of its depths. Keyset pagination: a paged walk never duplicates or skips a queue that exists throughout it, but counts, settings, and membership may drift between pages; counts are a snapshot, not a live read.

Sample

sh
curl -X GET "$SPOOLER_API/spools/<spool>/queues" \
  -H "Authorization: Bearer $SPOOLER_KEY"

Parameters

NameInTypeRequiredDescription
spoolpathIdentName, 1–64 chars, ^[A-Za-z0-9_:-]+$yesThe spool name.
limitqueryinteger, 1–1,000, default 100noMax queues per page.
afterqueryIdentName, 1–64 chars, ^[A-Za-z0-9_:-]+$noResume the listing just past this queue name (the previous page's next cursor); absent starts at the first queue.
matchquerystringnoKeep only queue names matching this RE2 regular expression, unanchored (anchor with ^ and $ for an exact match); absent lists everything. Pagination walks matching names only.

Responses

StatusDescription
200One page of the spool's queues.
400The request is malformed; the kind names the problem.
401The API key is missing or not recognized.
402The account is suspended.
403A plan limit refuses the operation; the kind names it.
404The spool or queue does not exist; the kind says which.
429The per-account request rate cap is exceeded; retry after the Retry-After delay.
503The spool is momentarily unavailable.

429 headers

HeaderDescription
Retry-AfterSeconds until the next request is admitted.