Get customer profile

Retrieve a unified 360° customer profile

GET /organizations/{organization_id}/projects/{project_id}/customer-profiles/{customer_profile_id}

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/customer-profiles/PROFILE_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/customer-profiles/${profileId}`,
  { headers: { "X-API-Key": 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={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)

200

{
  "status": "success",
  "message": "Customer profile retrieved successfully",
  "data": {
    "_id": "665f40000000000000000001",
    "name": "Alex Rivera",
    "display_id": "CUS-1042",
    "phone_numbers": [
      {
        "value": "[phone]",
        "normalized": "[phone]",
        "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

X-API-Key · string · required

Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id · string · required

Organization ID. Must match the API key.

project_id · string · required

Project ID. Must match the API key.

customer_profile_id · string · required

Customer profile ID.

Response

_id · string · required

Customer profile ID.

name · string

Display name.

display_id · string

Human-readable customer id.

phone_numbers · array · required

Phone contact methods.

emails · array · required

Email contact methods.

channel_identities · array · required

Channel identities (channel_type, identity_key, first/last seen).

properties · object · required

Custom property bag.

conversation_count · integer · required

Total conversations.

call_count · integer · required

Voice call count.

chat_count · integer · required

Chat conversation count.

Errors

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

404 · Not Found

Customer profile not found in this project.

cURL

curl -X GET "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/customer-profiles/PROFILE_ID" \
  -H "X-API-Key: bot_live_YOUR_KEY"

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/customer-profiles/${profileId}`,
  { headers: { "X-API-Key": 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={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
)

200

{
  "status": "success",
  "message": "Customer profile retrieved successfully",
  "data": {
    "_id": "665f40000000000000000001",
    "name": "Alex Rivera",
    "display_id": "CUS-1042",
    "phone_numbers": [
      {
        "value": "[phone]",
        "normalized": "[phone]",
        "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
}