Unified Customer Profile

Aggregated customer profile combining identities, interactions, journeys, experiments, and consent data into a single view.

GET /api/v1/customers//unified-profile

Returns a comprehensive profile for a customer, aggregating data from multiple sources into named sections. Supports selective section loading for performance.

Path Parameters

Parameter	Type	Description
customerId	string	Customer identifier

Query Parameters

Parameter	Type	Required	Description
format	string	No	Set to structured to return the new structured profile format with demographics, interactions, clv, metrics, and suppressions sections. If omitted, the legacy section-based format is used.
sections	string	No	Comma-separated list of sections to include (legacy format only). If omitted, all sections are returned.

Available Sections

Section	Description
identities	Identity links (email, phone, device IDs) with confidence scores
interactions	Recent interaction history (last 20 events)
segments	Customer segment memberships
journeys	Active and completed journey enrollments
experiments	Experiment variant assignments
consent	Consent and preference records

Example

# Full profile (legacy section-based format)
curl https://playground.kaireonai.com/api/v1/customers/CUST001/unified-profile \
  -H "X-Tenant-Id: my-tenant"

# Selective sections (legacy format)
curl "https://playground.kaireonai.com/api/v1/customers/CUST001/unified-profile?sections=identities,interactions" \
  -H "X-Tenant-Id: my-tenant"

# Structured format
curl "https://playground.kaireonai.com/api/v1/customers/CUST001/unified-profile?format=structured" \
  -H "X-Tenant-Id: my-tenant"

Response

{
  "customerId": "CUST001",
  "tenantId": "my-tenant",
  "sections": [
    {
      "name": "identities",
      "data": [
        { "type": "email", "value": "[e-mail]", "confidence": 1.0 },
        { "type": "phone", "value": "[phone]", "confidence": 0.95 }
      ]
    },
    {
      "name": "interactions",
      "data": [
        {
          "id": "ih_001",
          "offerId": "off_001",
          "channelId": "ch_001",
          "interactionType": "impression",
          "timestamp": "2026-03-28T10:30:00Z"
        }
      ]
    },
    {
      "name": "segments",
      "data": [
        { "segmentId": "seg_001", "segmentName": "High Value", "memberSince": "2026-01-15T00:00:00Z" }
      ]
    }
  ],
  "computedAt": "2026-03-30T12:00:00.000Z"
}

Extension Point

Custom profile sections can be registered server-side via the profile-section extension API. This allows plugins and extensions to contribute additional data to the unified profile.

Roles

admin, editor, viewer

See also: Customers | Identity | Profiles