Skip to content
vocapable.Docs

The team board: who is on a call, available or away; today

GET
/v1/workspace/team/board
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/team/board \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
team_id
Any of:
string
<= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
TeamBoard
object
generated_at
required
Generated At
string format: date-time
members
required
Members
Array<object>
TeamBoardMember
object
user
required
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
role
required
Role
string
Allowed values: owner manager rep
status
required
Status
string
Allowed values: on_call wrapping_up available away offline off_hours not_set invited
status_label
required
Status Label
string
presence_until
required
Any of:
string format: date-time
live_call
required
Any of:
TeamBoardLiveCall
object
call_id
required
Call Id
string
source
required
Source
string
Allowed values: workspace_call queue
direction
required
Direction
string
Allowed values: outbound inbound handoff
with_name
required
With Name
string
since
required
Since
string format: date-time
seconds
required
Seconds
integer
supervisable
Supervisable
boolean
supervised_by
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
supervision_mode
Any of:
string
Allowed values: listen whisper barge
working_now
required
Any of:
boolean
device_ready
required
Device Ready
boolean
agent
Any of:
TeamBoardAgentState

A teammate’s agent state on the team board (contact-center companies).

object
state
required
State
string
Allowed values: available reserved on_call after_call_work not_ready offline
reason_code
required
Any of:
string
reason_label
required
Any of:
string
since
required
Any of:
string format: date-time
acw_until
required
Any of:
string format: date-time
next_state
required
Any of:
string
Allowed values: available not_ready offline
next_reason_label
required
Any of:
string
presence_revision
required
Any of:
integer
queue
required
TeamBoardQueue
object
waiting
required
Waiting
integer
longest_wait_seconds
required
Any of:
integer
today
required
TeamBoardToday
object
answered_by_team
required
Answered By Team
integer
answered_by_ai
required
Answered By Ai
integer
missed
required
Missed
integer
voicemails
required
Voicemails
integer
returned
required
Returned
integer
timezone
required
Timezone
string
label
required
Label
string
longest_unanswered_promise
required
Any of:
TeamBoardPromise
object
kind
required
Kind
string
Allowed values: requested_callback callback_task
id
required
Id
string
title
required
Title
string
promised_at
required
Promised At
string format: date-time
overdue_seconds
required
Overdue Seconds
integer
owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
definitions
required
Definitions
Array<object>
WorkspaceMetricDefinition
object
key
required
Key
string
label
required
Label
string
definition
required
Definition
string
poll_seconds
required
Poll Seconds
integer
supervision_enabled
Supervision Enabled
boolean
contact_center_enabled
Contact Center Enabled
boolean
can_change_agent_state
Can Change Agent State
boolean
Example
{
  "members": [
    {
      "role": "owner",
      "status": "on_call",
      "live_call": {
        "source": "workspace_call",
        "direction": "outbound",
        "supervisable": false,
        "supervision_mode": "listen"
      },
      "agent": {
        "state": "available",
        "next_state": "available"
      }
    }
  ],
  "longest_unanswered_promise": {
    "kind": "requested_callback"
  },
  "supervision_enabled": false,
  "contact_center_enabled": false,
  "can_change_agent_state": false
}

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": {}
    }
  ]
}