curl --request GET \
--url https://api.example.com/api/conversations/persons/{person_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/conversations/persons/{person_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/conversations/persons/{person_id}', 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://api.example.com/api/conversations/persons/{person_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.example.com/api/conversations/persons/{person_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/conversations/persons/{person_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/persons/{person_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"addresses": [
{
"address": "<string>",
"door": "api",
"linked_at": "2023-11-07T05:31:56Z",
"routes": [
"<string>"
],
"channel": "<string>",
"our_identity": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"person_id": "<string>",
"target_kind": "agent",
"target_name": "<string>",
"locale": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Read a conversation person
The person row named by person_id — its identity, folded addresses and stored
locale (the BCP 47 tag the rendering layer resolves text against, or null when
none is known). The subject read that serves a person’s locale. A blank person_id is a
400; an unknown one a 404; no backend a loud 501.
curl --request GET \
--url https://api.example.com/api/conversations/persons/{person_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/conversations/persons/{person_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/conversations/persons/{person_id}', 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://api.example.com/api/conversations/persons/{person_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.example.com/api/conversations/persons/{person_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/conversations/persons/{person_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/persons/{person_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"addresses": [
{
"address": "<string>",
"door": "api",
"linked_at": "2023-11-07T05:31:56Z",
"routes": [
"<string>"
],
"channel": "<string>",
"our_identity": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"person_id": "<string>",
"target_kind": "agent",
"target_name": "<string>",
"locale": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Response
Success.
A single identity on one target: the one-or-more :class:PersonAddress rows the
platform treats as the same person for a (target_kind, target_name) pair.
A provisional person carries exactly ONE address — its first contact. Explicit pair-code redemption merges two persons into one (the union of their addresses); persons never cross targets. There is NO greeted flag: the row's existence is itself the first-contact marker, so a caller learns a first contact from whether it created the row. Runtime state that lives only in the deployment's Redis — deliberately NOT a backup section, the same family as a conversation record. Frozen.
Show child attributes
Show child attributes

