Read role-aware mobile field-operations readiness

GET

/v1/mobile/receptionist/readiness

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

Return current checks and their owned repair surfaces, never hidden diagnostics.

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

MobileReadiness

The current user’s role-specific field-operations checklist.

object

role

required

Role

string

Allowed values: admin manager rep

generated_at

required

Generated At

string format: date-time

items

required

Items

Array<object>

MobileReadinessItem

One no-PII readiness outcome and the surface that owns its next action.

object

key

required

Key

string

Allowed values: carrier_handoff staffing_eligibility schedule calendar_booking notifications integration_health transfer_destination availability

state

required

State

string

Allowed values: ready attention unavailable

reason_code

required

Reason Code

string

/^[a-z0-9_]{1,80}$/

next_action

required

Next Action

string

Allowed values: native browser support

destination

required

Destination

string

Allowed values: today team schedule notifications integrations support

Example

{
  "role": "admin",
  "items": [
    {
      "key": "carrier_handoff",
      "state": "ready",
      "next_action": "native",
      "destination": "today"
    }
  ]
}