---
title: "List customer model facts"
method: GET
path: "/api/v1/business/customer-model-facts"
tags: ["business"]
---

# List customer model facts

`GET /api/v1/business/customer-model-facts`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/customer-model-facts`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

List customers as Point11's models read them, their model facts: each one's current version number and every attribute of the customer model under its key (name included; a category, and a band as <key>.band, by its label; Location as its country and region codes, town, postal code, street and point; Household as its counts; product.definition, what its business profile says it sells on the customer's Product; buyerType), an attribute its buyer type lacks left out. Pass customerIds for named customers, under the same businessProfileId, locationKey, lifecycleStatus, search, audienceNames and field filters business_customers_list_v3 takes, in id order, up to 100 a page (page with nextCursor).

## Query parameters

- `limit` integer
- `cursor` string
- `customerIds` string[]: Only these customers, under every other filter
- `businessProfileId` string, uuid: Only this business profile's customers; omit for every profile
- `locationKey` string: Only the customers generated for this store: a store profile's location key, as business_store_profile_summaries_get_v1 lists them under its businessProfileId
- `lifecycleStatus` 'active' | 'archived' | 'all'
- `search` string: Match the customer's name
- `audienceNames` string[]: Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label
- `filters` string[]: Field conditions, each `<field>:<operator>:<value>`. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and `min..max`. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), `none` for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and `from..to`, read in UTC. performance (the latest Discovery outcome) takes is_any_of or is_none_of and won, lost or `none`.
- `filterMatch` 'all' | 'any': Whether a customer matches every condition (all, the default) or any one

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- BusinessCustomerModelFactsListResponse
  - `data` object[], required
    - `id` string, uuid, required
    - `version` integer, required: The customer's current version, which the facts state
    - `facts` object, required: The customer model's attributes by key, as Point11's models read them: a category and a band by label, never an id
  - `nextCursor` string, nullable, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)