queue.peek

Show the next eligible item per partition key without claiming it, plus the keys currently blocked by an active item.

Show what would be claimed next per partition key, without claiming.

Overview

Property	Value
Workflow type	Atomic
Library	App-queue
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	string	Yes	—	—
queue_name	string	Yes	—	—
limit	integer	No	—	—

Output Schema

Field	Type	Required	Default	Description
next_items	json	No	—	—
blocked_keys	json	No	—	—
count	integer	No	—	—
error	string	No	—	Error-as-field envelope populated when query() raises.
error_type	string	No	—	Error-as-field envelope populated when query() raises.

States

State	Initial	Terminal	Success	Auto-advance	Description
done	Yes	Yes	Yes	—	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "queue.peek",
  "initial_data": {
    "organization_uuid": "value",
    "queue_name": "value"
  }
}