Skip to content
vocapable.Docs

Everyone in a queue now (supervisors)

GET
/v1/workspace/contact-center/wallboard/waiting
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/wallboard/waiting \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
queue
Any of:
Array<string>
<= 50 items

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWaitingCallers
object
data
required
Data
Array<object>
CcWaitingCaller
object
ticket_id
required
Ticket Id
string
queue_key
required
Queue Key
string
queue_name
required
Queue Name
string
offered_at
required
Offered At
string format: date-time
wait_seconds
required
Wait Seconds
integer
caller_label
required
Caller Label
string
state
required
State
string
base_priority
required
Any of:
integer
effective_priority
required
Any of:
integer
callback
required
Callback
boolean
actionable
required
Actionable
boolean
queues
required
Queues
Array<object>
CcBoardQueueRef
object
key
required
Key
string
name
required
Name
string
is_line
required
Is Line
boolean
Examplegenerated
{
  "data": [
    {
      "ticket_id": "example",
      "queue_key": "example",
      "queue_name": "example",
      "offered_at": "2026-04-15T12:00:00Z",
      "wait_seconds": 1,
      "caller_label": "example",
      "state": "example",
      "base_priority": 1,
      "effective_priority": 1,
      "callback": true,
      "actionable": true
    }
  ],
  "queues": [
    {
      "key": "example",
      "name": "example",
      "is_line": true
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}