Skip to main content
GET
/
api
/
user
/
profile
Get current user profile
curl --request GET \
  --url https://your-instance.example.com/api/user/profile \
  --header 'Authorization: Bearer <token>'
{
  "user": {
    "_id": "64ee9a8b1e7f2a0011223399",
    "fullName": "Alex Rep",
    "email": "alex@acme.example",
    "accessRole": "DEPARTMENT_HEAD",
    "organizationId": "64ee9a8b1e7f2a0011223344"
  },
  "persona": {
    "_id": "64eea1110000000000000040",
    "organization": "Acme Corp",
    "timezone": "America/Toronto"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

User profile returned

Returned by GET /api/user/profile. user is the projected User document; persona is the resolved Persona (or null when the user has none).

​
user
object
required

Authenticated user profile document. Fields are projected from User and may vary slightly depending on which controller served the request.

Example:
{
  "_id": "64ee9a8b1e7f2a0011223399",
  "accessRole": "DEPARTMENT_HEAD",
  "departmentId": "64eea1110000000000000020",
  "fullName": "Alex Rep",
  "email": "alex@acme.example",
  "phoneNumber": "+14155550199",
  "designation": "Senior Account Executive",
  "callForwardingEnabled": true,
  "persona": "64eea1110000000000000040",
  "conversationOpenPreference": "always",
  "organizationId": "64ee9a8b1e7f2a0011223344"
}
​
persona
object | null

Persona document linked to a user (may be null when unset).

Example:
{
  "_id": "64eea1110000000000000040",
  "user": "Alex Rep",
  "position": "Senior Account Executive",
  "userEmail": "alex@acme.example",
  "organization": "Acme Corp",
  "organizationAddress": "500 Bay St, Toronto, ON",
  "leadProvider": "Facebook Lead Ads",
  "organizationWebsite": "https://acme.example",
  "organizationCity": "Toronto",
  "region": "Ontario",
  "timezone": "America/Toronto",
  "businessHours": "9am-6pm Mon-Fri"
}