business

List customer pool selections

List every customer business_customers_list_v3 lists under the same businessProfileId, locationKey, lifecycleStatus, search, audienceNames and filters, by id alone: each one's id, pool status and source, up to 1,000 a page in id order (page with nextCursor). It is what selecting every matching customer selects, never their content; read the customers themselves through business_customers_list_v3's customerIds.

get/api/v1/business/customer-pool-selections

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/customer-pool-selections
  • 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, as business_customers_list_v3 takes them: only customers in any named source and in any named label

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

Changes

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