Skip to content
vocapable.Docs

Your next actions, and the owner exceptions

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileWorkspaceToday
object
generated_at
required
Generated At
string format: date-time
window
required
MobileWorkspaceWindow

The company-local calendar day Today’s counts are taken over.

object
timezone
required
Timezone
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
counts
required
MobileWorkspaceTodayCounts
object
open_tasks
required
Open Tasks
integer
overdue_tasks
required
Overdue Tasks
integer
callbacks_due_today
required
Callbacks Due Today
integer
approvals_awaiting_you
required
Approvals Awaiting You
integer
handoffs_awaiting_you
required
Handoffs Awaiting You
integer
priorities
required
Priorities
Array<object>
MobileWorkspacePriority

One item of the ordered “do this next” list: the record, not a copy of it.

object
kind
required
Kind
string
Allowed values: callback follow_up approval handoff_acceptance
title
required
Title
string
resource_type
required
Resource Type
string
Allowed values: task approval handoff
resource_id
required
Resource Id
string
organization_id
required
Any of:
string
organization_name
required
Any of:
string
contact_id
required
Any of:
string
due_at
required
Any of:
string format: date-time
overdue
required
Overdue
boolean
promises
required
Promises
Array<object>
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
exceptions
required
Any of:
Array<object>
MobileWorkspaceException

An owner/manager exception: a count of contributing records plus a few of their ids.

object
kind
required
Kind
string
Allowed values: missed_commitments unassigned_customers blocked_people handoffs_awaiting_acceptance connections_need_attention
count
required
Count
integer
title
required
Title
string
detail
required
Detail
string
resource_ids
required
Resource Ids
Array<string>
Example
{
  "priorities": [
    {
      "kind": "callback",
      "resource_type": "task"
    }
  ],
  "promises": [
    {
      "kind": "follow_up",
      "subject_type": "handoff",
      "status": "open"
    }
  ],
  "exceptions": [
    {
      "kind": "missed_commitments"
    }
  ]
}