Get current user profile
curl --request GET \
--url https://your-instance.example.com/api/user/profile \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/user/profile"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/user/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/user/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/user/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/user/profile")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/user/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"user": {
"_id": "64ee9a8b1e7f2a0011223399",
"fullName": "Alex Rep",
"email": "alex@acme.example",
"accessRole": "DEPARTMENT_HEAD",
"organizationId": "64ee9a8b1e7f2a0011223344"
},
"persona": {
"_id": "64eea1110000000000000040",
"organization": "Acme Corp",
"timezone": "America/Toronto"
}
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}Users
Get current user profile
Returns the authenticated user profile, including organization, role, persona, automations, and other settings.
GET
/
api
/
user
/
profile
Get current user profile
curl --request GET \
--url https://your-instance.example.com/api/user/profile \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/user/profile"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/user/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/user/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/user/profile"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/user/profile")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/user/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"user": {
"_id": "64ee9a8b1e7f2a0011223399",
"fullName": "Alex Rep",
"email": "alex@acme.example",
"accessRole": "DEPARTMENT_HEAD",
"organizationId": "64ee9a8b1e7f2a0011223344"
},
"persona": {
"_id": "64eea1110000000000000040",
"organization": "Acme Corp",
"timezone": "America/Toronto"
}
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}Authorizations
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).
Authenticated user profile document. Fields are projected from User and may vary slightly depending on which controller served the request.
Show child attributes
Show child attributes
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 document linked to a user (may be null when unset).
Show child attributes
Show child attributes
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"
}
⌘I