List customer model facts
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).
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)
Query parameters
Only these customers, under every other filter
Only this business profile's customers; omit for every profile
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
Match the customer's name
Source and label names, as business_customers_list_v3 takes them: only customers in any named source and in any named label
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.
Whether a customer matches every condition (all, the default) or any one
Headers
Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.
Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.