curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/customer-profiles/PROFILE_ID" \
-H "Authorization: Bearer bot_live_YOUR_KEY"
const response = await fetch(
`https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/customer-profiles/${profileId}`,
{ headers: { "Authorization": `Bearer ${process.env.BOTCADENCE_API_KEY}` } }
);
import os
import requests
response = requests.get(
f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/customer-profiles/{customer_profile_id}",
headers={"Authorization": f"Bearer {os.environ['BOTCADENCE_API_KEY']}"},
)
{
"status": "success",
"message": "Customer profile retrieved successfully",
"data": {
"_id": "665f40000000000000000001",
"name": "Alex Rivera",
"email": null,
"phone_number": "+14155552671",
"display_id": "CUS-1042",
"phone_numbers": [
{
"value": "+14155552671",
"normalized": "+14155552671",
"source": "voice"
}
],
"emails": [],
"channel_identities": [
{
"channel_type": "web",
"identity_key": "anon_abc",
"first_seen_at": "2026-07-01T10:00:00Z",
"last_seen_at": "2026-07-21T15:04:00Z"
}
],
"properties": { "plan": "pro" },
"conversation_count": 5,
"call_count": 2,
"chat_count": 3
},
"status_code": 200
}
Customer Profiles
Get customer profile
Retrieve a unified 360° customer profile
GET
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
customer-profiles
/
{customer_profile_id}
curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/customer-profiles/PROFILE_ID" \
-H "Authorization: Bearer bot_live_YOUR_KEY"
const response = await fetch(
`https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/customer-profiles/${profileId}`,
{ headers: { "Authorization": `Bearer ${process.env.BOTCADENCE_API_KEY}` } }
);
import os
import requests
response = requests.get(
f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/customer-profiles/{customer_profile_id}",
headers={"Authorization": f"Bearer {os.environ['BOTCADENCE_API_KEY']}"},
)
{
"status": "success",
"message": "Customer profile retrieved successfully",
"data": {
"_id": "665f40000000000000000001",
"name": "Alex Rivera",
"email": null,
"phone_number": "+14155552671",
"display_id": "CUS-1042",
"phone_numbers": [
{
"value": "+14155552671",
"normalized": "+14155552671",
"source": "voice"
}
],
"emails": [],
"channel_identities": [
{
"channel_type": "web",
"identity_key": "anon_abc",
"first_seen_at": "2026-07-01T10:00:00Z",
"last_seen_at": "2026-07-21T15:04:00Z"
}
],
"properties": { "plan": "pro" },
"conversation_count": 5,
"call_count": 2,
"chat_count": 3
},
"status_code": 200
}
Returns one unified customer profile with contact methods, channel identities, properties, and conversation stats.
Authentication
string
required
Project API key for this organization and project. Format:
bot_live_…Path parameters
string
required
Organization ID. Must match the API key.
string
required
Project ID. Must match the API key.
string
required
Customer profile ID.
Response
string
required
Customer profile ID.
string
Display name.
string | null
Canonical primary email. Additional addresses are listed in
emails.string | null
Canonical primary phone number. Additional numbers are listed in
phone_numbers.string
Human-readable customer id.
array
required
Phone contact methods.
array
required
Email contact methods.
array
required
Channel identities (
channel_type, identity_key, first/last seen).object
required
Custom property bag.
integer
required
Total conversations.
integer
required
Voice call count.
integer
required
Chat conversation count.
Errors
Unauthorized
Missing, invalid, or revoked API key.
Forbidden
API key is not authorized for this organization or project.
Not Found
Customer profile not found in this project.
curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/customer-profiles/PROFILE_ID" \
-H "Authorization: Bearer bot_live_YOUR_KEY"
const response = await fetch(
`https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/customer-profiles/${profileId}`,
{ headers: { "Authorization": `Bearer ${process.env.BOTCADENCE_API_KEY}` } }
);
import os
import requests
response = requests.get(
f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/customer-profiles/{customer_profile_id}",
headers={"Authorization": f"Bearer {os.environ['BOTCADENCE_API_KEY']}"},
)
{
"status": "success",
"message": "Customer profile retrieved successfully",
"data": {
"_id": "665f40000000000000000001",
"name": "Alex Rivera",
"email": null,
"phone_number": "+14155552671",
"display_id": "CUS-1042",
"phone_numbers": [
{
"value": "+14155552671",
"normalized": "+14155552671",
"source": "voice"
}
],
"emails": [],
"channel_identities": [
{
"channel_type": "web",
"identity_key": "anon_abc",
"first_seen_at": "2026-07-01T10:00:00Z",
"last_seen_at": "2026-07-21T15:04:00Z"
}
],
"properties": { "plan": "pro" },
"conversation_count": 5,
"call_count": 2,
"chat_count": 3
},
"status_code": 200
}