Skip to content
vocapable.Docs

Workspace setup: the saved goal and progress read from real records

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceSetup

Progress derived from real records; next_missing replaces any percentage.

object
goal
required
Any of:
string
Allowed values: receptionist sales_team people_ai
steps
required
Steps
Array<object>
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
next_missing
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
ready
required
Ready
boolean
revision
required
Any of:
integer
can_edit
required
Can Edit
boolean
Example
{
  "goal": "receptionist",
  "steps": [
    {
      "key": "company",
      "state": "done"
    }
  ],
  "next_missing": {
    "key": "company",
    "state": "done"
  }
}