The signed-in person in this company, and what they may do

GET

/v1/workspace/me

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

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceMe

The person behind this console key, in this company, and what they may do.

object

user_id

required

User Id

string

membership_id

required

Any of:

string
null

string

display_name

required

Display Name

string

email

required

Email

string

role

required

Role

string

Allowed values: owner manager rep

capabilities

required

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

company_id

required

Company Id

string

company_name

required

Company Name

string

timezone

required

Any of:

string
null

string

custom_role_name

Any of:

string
null

string

team_scope

Any of:

Array<string>
null

Array<string>

permissions

Permissions

Array<string>

Example

{
  "role": "owner",
  "capabilities": [
    "view_all_customers"
  ]
}