business

List customers (v2)

Deprecated: use business.customers.list.v3 (business_customers_list_v3), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List the organization's customers (active ones by default), optionally for one business profile or one of its stores (locationKey), newest first unless sorted: each one's name, its table attributes under the customer model's keys (a category, a band as <key>.band, the Product and the Buyer type each as its id and label; Location as one line), audiences, sources, and latest Discovery outcome, with the pool's status counts and audience facets. Filter by lifecycle status, name search, audience names and field conditions; page with nextCursor.

get/api/v1/business/customers-v2

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/customers-v2
  • 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

limitinteger
cursorstring
businessProfileIdstring uuid

Only this business profile's customers; omit for every profile

locationKeystring

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'
searchstring

Match the customer's name

audienceNamesstring[]

Source and label names: only customers in any named source and in any named label (system audiences are labels); a kind none names narrows nothing

customerIdsstring[]

Only these customers, under every other filter

includeEditableboolean

Also answer the page's customers as business_customers_update_v4 edits them (edits): each one's version, editable fields and their options

sort'createdAt' | 'customerId' | 'name' | 'profile' | 'performance' | 'audiences' | 'sources' | 'status' | 'gender' | 'age' | 'language' | 'location' | 'householdIncome' | 'employer' | 'companySize' | 'annualRevenue' | 'intentStage' | 'trigger'
direction'asc' | 'desc'
filtersstring[]

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-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

nextCursorstring nullable required
totalCountinteger required
audienceFacetTotalinteger required
interviewEligibleCustomerIdsstring[] required
audienceTypesstring[] required

The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column.

Changes

No recorded changes to this operation across all 1 revision of this API.