Skip to content

List customer profiles

GET/customer360/profiles

Returns a paginated list of all unified customer profiles ordered by most recently updated, with health scores, identity counts, and timeline event counts. Use this as the primary customer directory view.

Request

Query parameters

NameTypeRequiredDescription
pageintegerNo

Page number (15 profiles per page).

Default: 1

Responses

200 Paginated list of customer profiles with health and activity metadata

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · CustomerProfileV1No
data[].idintegerNo

Auto-incremented primary key.

data[].display_namestringNo

Full display name of the customer.

Example: "Kwame Mensah"

data[].primary_emailstring (email), nullableNo

Primary contact email address.

Example: "kwame.mensah@example.test"

data[].primary_phonestring, nullableNo

Primary phone number.

Example: "+233201234567"

data[].external_idsobject, nullableNo

Cross-system ID map (system name → external record ID).

data[].attributesobject, nullableNo

Arbitrary segmentation attributes.

data[].identities_countintegerNo

Number of linked identity records from external systems.

Example: 3

data[].timeline_items_countintegerNo

Number of behavioural timeline events recorded for this profile.

Example: 27

data[].health_scoreobject · CustomerHealthScoreV1No

A computed health score indicating the overall customer relationship quality.

data[].health_score.profile_idintegerNo

ID of the associated customer profile.

Example: 42

data[].health_score.scorenumberNo

Numeric health score from 0 (worst) to 100 (best).

Example: 82.0

data[].health_score.bandstringNo

Human-readable health band derived from the score. Typical bands: 'healthy' (70–100), 'at_risk' (40–69), 'churned' (0–39).

Example: "healthy"

data[].health_score.statusstringNo

Machine-readable health status.

One of: "healthy", "at_risk", "churned", "unknown" · Example: "healthy"

data[].health_score.factorsarray of objectNo

Scoring factor breakdown showing what drove the final score.

data[].health_score.factors[].factorstringNo

Name of the scoring dimension.

data[].health_score.factors[].weightnumberNo

Relative weight of this factor in the overall score.

data[].health_score.factors[].valuenumberNo

Computed sub-score for this factor.

data[].health_score.calculated_atstring (date-time), nullableNo

Timestamp of the most recent score calculation.

data[].updated_atstring (date-time)No

Last update timestamp.

Example

{
  "data": [
    {
      "id": 42,
      "display_name": "Kwame Mensah",
      "primary_email": "kwame.mensah@example.test",
      "primary_phone": "+233201234567",
      "external_ids": {
        "whmcs_client": 105,
        "stripe_customer": "cus_abc123"
      },
      "attributes": {
        "tier": "enterprise",
        "industry": "fintech"
      },
      "identities_count": 3,
      "timeline_items_count": 27,
      "health_score": {
        "score": 82.0,
        "band": "healthy",
        "status": "healthy"
      },
      "updated_at": "2026-04-07T09:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/customer360/profiles" \
  -H "Accept: application/json"
Loading