Read the native Owner Command Center workspace overview

GET

/v1/mobile/workspace/overview

const url = 'https://api.vocapable.com/v1/mobile/workspace/overview';
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/overview \
  --header 'Authorization: Bearer <token>'

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

MobileWorkspaceOverview

object

workspace

required

MobileWorkspaceIdentity

The active workspace label and role; no user account directory fields.

object

membership_id

required

Membership Id

string

>= 1 characters <= 128 characters

tenant_id

required

Tenant Id

string

>= 1 characters <= 128 characters

label

required

Label

string

>= 1 characters <= 200 characters

role

required

Role

string

Allowed values: admin manager rep

receptionist

required

MobileWorkspaceReceptionistHealth

object

state

required

State

string

Allowed values: healthy attention unavailable

label

required

Label

string

>= 1 characters <= 120 characters

detail

required

Detail

string

>= 1 characters <= 280 characters

open_task_count

required

Open Task Count

integer

production_ready

required

Production Ready

boolean

subscription

Any of:

MobileWorkspaceSubscriptionPreview
null

MobileWorkspaceSubscriptionPreview

The compact billing/capacity headline allowed on the Workspace Hub.

object

status

required

Status

string

Allowed values: trialing active past_due paused canceled unavailable

plan_label

required

Plan Label

string

>= 1 characters <= 160 characters

usage_label

Any of:

string
null

string

<= 160 characters

capacity_label

Any of:

string
null

string

<= 160 characters

spend_cap_progress_bps

Any of:

integer
null

integer

<= 10000

payment_attention

required

Payment Attention

string

Allowed values: none attention unavailable

next_renewal_at

Any of:

string
null

string format: date-time

generated_at

required

Generated At

string format: date-time

Example

{
  "workspace": {
    "role": "admin"
  },
  "receptionist": {
    "state": "healthy"
  },
  "subscription": {
    "status": "trialing",
    "payment_attention": "none"
  }
}