Skip to content
vocapable.Docs

Bootstrap the authenticated mobile workspace

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

Successful Response

Media typeapplication/json
MobileBootstrapProfile

The authenticated app’s identity/bootstrap response at GET /v1/mobile/me.

Operational selector data (contacts, agents, schedules, team rows) deliberately stays on its own capability-gated endpoints. This profile contains only the facts every app boot needs and no push token or refresh/session secret.

object
tenant_id
required
Tenant Id
string
membership
required
TenantMembershipSummary
object
id
required
Id
string
tenant_id
required
Tenant Id
string
account_id
required
Account Id
string
display_name
Any of:
string
role
required
TenantMembershipRole

The only roles a customer can hold in one workspace.

string
Allowed values: admin manager rep
human_rep_id
Any of:
string
status
required
Status
string
Allowed values: active suspended revoked
sessions_valid_after
required
Sessions Valid After
string format: date-time
capabilities
required
Capabilities
Array<string>
Allowed values: activity:read insights:read schedule:write emergency_override:write team:read team:availability:write team:members:manage team:transfer_destinations:manage calls:outbound:start own_availability:write own_handoffs:read handoff_booking:write device_sessions:manage operations_tasks:read operations_tasks:mutate operations_tasks:assign agent_drafts:write workspace:read workspace:switch billing:read billing:write receptionist_studio:read receptionist_studio:write workspace_crm:read workspace_crm:write workspace_approvals:review workspace_exceptions:read workspace_integrations:read workspace_calls:embedded emergency_lines:manage emergency_calls:read numbers:read
device
required
MobileDeviceSummary
object
id
required
Id
string
platform
required
Platform
string
Allowed values: ios android
device_label
Any of:
string
status
required
Status
string
Allowed values: active revoked
last_seen_at
required
Last Seen At
string format: date-time
permissions
required
MobileEffectivePermissions

What this person may do in the company, as the workspace decides it (CC7-R2).

capabilities (on :class:MobileBootstrapProfile) says which native surfaces exist for the session; these are the workspace capabilities behind them - the built-in role’s set, or the custom role’s after the same narrowing every request applies - and the person’s team scope. The app gates screens, tiles and buttons on them instead of on the role name (a custom role sits on a manager membership whatever it grants). The server still decides every request; this only says what not to offer.

object
workspace_capabilities
required
Workspace Capabilities
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
permissions
Permissions
Array<string>
custom_role_name
Any of:
string
team_scope
Any of:
Array<string>
Example
{
"membership": {
"role": "admin",
"status": "active"
},
"capabilities": [
"activity:read"
],
"device": {
"platform": "ios",
"status": "active"
},
"permissions": {
"workspace_capabilities": [
"view_all_customers"
]
}
}