Skip to content
vocapable.Docs

Your day: priorities, metrics, promises, story and exceptions

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceToday
object
generated_at
required
Generated At
string format: date-time
timezone
required
Timezone
string
scope
required
Scope
string
Allowed values: team self
priorities
required
Priorities
Array<object>
WorkspacePriorityItem

One thing to do next, in the handoff’s order, opening its exact record.

object
kind
required
Kind
string
Allowed values: active_call reply callback follow_up approval new_work
rank
required
Rank
integer
title
required
Title
string
detail
required
Detail
string
record_type
required
Record Type
string
record_id
required
Record Id
string
organization_id
required
Any of:
string
due_at
required
Any of:
string format: date-time
overdue
required
Overdue
boolean
link
required
Link
string
metrics
required
Metrics
Array<object>
WorkspaceTodayMetric
object
key
required
Key
string
Allowed values: open_opportunities open_value next_steps people_available
label
required
Label
string
value
required
Value
integer
amounts
Any of:
Array<object>
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
caption
required
Caption
string
definition
required
Definition
string
window
required
Window
string
link
required
Link
string
promises
required
Promises
Array<object>
WorkspaceTodayPromise
object
task
required
WorkspaceTask
object
id
required
Id
string
kind
required
Kind
string
Allowed values: follow_up callback delivery review case_response meeting_prep
title
required
Title
string
organization_id
required
Any of:
string
contact_id
required
Any of:
string
opportunity_id
required
Any of:
string
subject_type
required
Any of:
string
Allowed values: handoff case meeting approval call quote
subject_id
required
Any of:
string
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
due_at
required
Any of:
string format: date-time
status
required
Status
string
Allowed values: open done cancelled
completed_at
required
Any of:
string format: date-time
completed_by_user_id
required
Any of:
string
completion_note
required
Any of:
string
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
organization_name
required
Any of:
string
overdue
required
Overdue
boolean
link
required
Link
string
feed
required
Feed
Array<object>
WorkspaceFeedItem
object
entry
required
WorkspaceTimelineEntry
object
id
required
Id
string
organization_id
required
Any of:
string
contact_id
required
Any of:
string
opportunity_id
required
Any of:
string
kind
required
Kind
string
Allowed values: call note message ai stage task meeting quote handoff case import ownership policy integration
title
required
Title
string
body
required
Any of:
string
actor
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
actor_kind
required
Actor Kind
string
Allowed values: human ai system integration
subject_type
required
Any of:
string
subject_id
required
Any of:
string
occurred_at
required
Occurred At
string format: date-time
organization_name
required
Any of:
string
link
required
Any of:
string
exceptions
required
Any of:
Array<object>
WorkspaceException
object
kind
required
Kind
string
Allowed values: unassigned overdue_commitment coverage_gap blocked_rep integration_attention handoff_pending handoff_declined help_request
title
required
Title
string
detail
required
Detail
string
count
required
Count
integer
link
required
Link
string
items
required
Items
Array<object>
WorkspaceExceptionItem
object
id
required
Id
string
label
required
Label
string
detail
required
Detail
string
link
required
Link
string
reviews
required
Reviews
Array<object>
WorkspaceApproval

One request for review, pinned to the exact payload reviewed (its digest).

object
id
required
Id
string
action_type
required
Action Type
string
subject_type
required
Subject Type
string
subject_id
required
Subject Id
string
digest
required
Digest
string
summary
required
Summary
object
key
additional properties
any
requested_by
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
reviewer
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
status
required
Status
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
decided_by
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
decided_at
required
Any of:
string format: date-time
reason
required
Any of:
string
expires_at
required
Expires At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
my_requests
required
My Requests
Array<object>
WorkspaceApproval

One request for review, pinned to the exact payload reviewed (its digest).

object
id
required
Id
string
action_type
required
Action Type
string
subject_type
required
Subject Type
string
subject_id
required
Subject Id
string
digest
required
Digest
string
summary
required
Summary
object
key
additional properties
any
requested_by
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
reviewer
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
status
required
Status
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
decided_by
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
decided_at
required
Any of:
string format: date-time
reason
required
Any of:
string
expires_at
required
Expires At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
team
required
Team
Array<object>
WorkspaceTodayTeammate
object
user_id
required
Any of:
string
name
required
Name
string
role
required
Role
string
presence_label
required
Presence Label
string
device_label
required
Device Label
string
ready_to_answer
required
Ready To Answer
boolean
digest
required
Any of:
WorkspaceOwnerDigest

Today at a glance for owners and managers (J10), from the same report service.

object
window
required
Window
string
conversations
required
Conversations
integer
follow_ups_completed
required
Follow Ups Completed
integer
won_amounts
required
Won Amounts
Array<object>
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
collected_amounts
required
Collected Amounts
Array<object>
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
link
required
Link
string
setup_next
required
Any of:
WorkspaceSetupStep
object
key
required
Key
string
Allowed values: company knowledge goal people phone routing records test launch
title
required
Title
string
description
required
Description
string
state
required
State
string
Allowed values: done missing optional skipped not_needed
required
required
Required
boolean
evidence
required
Evidence
string
link
required
Link
string
Example
{
  "scope": "team",
  "priorities": [
    {
      "kind": "active_call"
    }
  ],
  "metrics": [
    {
      "key": "open_opportunities"
    }
  ],
  "promises": [
    {
      "task": {
        "kind": "follow_up",
        "subject_type": "handoff",
        "status": "open"
      }
    }
  ],
  "feed": [
    {
      "entry": {
        "kind": "call",
        "actor_kind": "human"
      }
    }
  ],
  "exceptions": [
    {
      "kind": "unassigned"
    }
  ],
  "reviews": [
    {
      "status": "awaiting_review"
    }
  ],
  "my_requests": [
    {
      "status": "awaiting_review"
    }
  ],
  "setup_next": {
    "key": "company",
    "state": "done"
  }
}