Queues
Queues
List a queue's waiting records
GET
The records waiting in the queue, oldest or newest first, with their payload, and how many wait in total.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
workflows_app_queue_id*stringThe queue.
Format
uuidlimit?LimitMaximum number of records returned, at most 100
Range
1 <= value <= 100Default
20offset?OffsetNumber of items skipped before the first one returned
Range
0 <= valueDefault
0region*RegionsData region of the resources: besg (Europe) or usnv (United States), as GET /v1/regions lists them.
Value in
"besg""usnv"order?QueueRecordOrderWhich waiting records come first: the oldest (the next to be flushed) or the newest
Default
"oldest"Value in
"oldest""newest"OK
application/json- response
data*array<>has_more*Has MoreWhether more items follow this page: request the next one with offset + limit
limit*Limitoffset*Offsetwaiting_record_count*Waiting Record CountEvery record waiting in the queue, not only this page
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/queues/497f6eca-6276-4993-bfeb-53cbbbba6f08/records?region=besg'{ "data": [ { "record_id": "<record_id>", "created_time": "<created_time>", "process_start_time": "<process_start_time>", "is_to_retry": false, "data": "<data>" } ], "has_more": false, "limit": 0, "offset": 0, "waiting_record_count": 0}