Describe the authenticated principal

GET

/v1/me

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

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

CurrentPrincipalResource

GET /v1/me - the principal, plus the human behind it where one is resolvable.

user_id is the usr_ id of the tenant user whose first-party dashboard session accompanied the request (the browser attaches the session cookie alongside the console key). It is what lets the portal offer “assign to me” against surfaces keyed on users.id. Null - and typed that way - for a key-only caller: an API key names an integration, not a person, and inventing one would be worse than answering none.

object

tenant_id

required

Tenant Id

string

api_key_id

required

Api Key Id

string

mode

required

Mode

string

Allowed values: live test

scopes

required

Scopes

Array<string>

user_id

Any of:

string
null

string

Example

{
  "mode": "live"
}