Read server-derived mobile Get Live work

GET

/v1/mobile/workspace/setup

const url = 'https://api.vocapable.com/v1/mobile/workspace/setup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

MobileWorkspaceSetup

object

generated_at

required

Generated At

string format: date-time

items

Items

Array<object>

MobileSetupItem

One server-derived next action; a client cannot check it off locally.

object

key

required

Key

string

Allowed values: team_coverage transfer_destination availability schedule notifications calendar_booking receptionist capacity portal

state

required

State

string

Allowed values: ready attention blocked unavailable

title

required

Title

string

>= 1 characters <= 120 characters

detail

required

Detail

string

>= 1 characters <= 280 characters

next_action

required

Next Action

string

Allowed values: native browser support none

destination

required

Destination

string

Allowed values: team schedule notifications integrations workspace subscription portal support

Example

{
  "items": [
    {
      "key": "team_coverage",
      "state": "ready",
      "next_action": "native",
      "destination": "team"
    }
  ]
}