/v1/definitions/{key}/queues/{queue}/pullPull the next record from a work queue
Claims the oldest unclaimed deal in one queue FOR THE CALLER and answers it, so two people working the same queue never take the same deal. The queue segment names a stage band of the deals board's own status vocabulary, and an unknown one is refused with the list of bands that exist. role is optional and defaults to opener; unclaimed means that role's person cell is empty. An empty queue is a 404 — 'nothing waiting' is the answer, not a failure. Deals page only.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"archived_at": "string",
"assignees": {},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"position": 1,
"source": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}