business

Get customers (v3)

Deprecated: use business.customers.get.v4 (business_customers_get_v4), 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. Get one customer by its id, customer key, or the id of the run that generated it: its current version as the customer model states it (persona: every attribute under its key, in the model's groups and order; each category as its id and label; Age, Household income and Company size with the band stored beside them; Employer with its source link; Household; Product; Buyer type, derived from the audience's declared type, with the attributes only the other buyer type has left out), its editable fields by the same keys with the options each category and band may take (a fixed list whole; an open category's profile options and the values members added for its business profile, marked memberAdded), its audiences and sources, any CRM field pins and open pin reviews by field, and its latest activity in Discovery, Experience, and Research.

get/api/v1/business/customers-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/customers-v3/{id}
  • 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)

Path parameters

idstring required

The customer's id or customer key, or the id of the run that generated it

Headers

Point11-Organizationstring uuid

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

Response

Success.

idstring uuid required
customerKeystring required
businessProfileIdstring uuid required
brandProfileIdstring uuid required
businessProfileKeystring nullable required
profileLabelstring required
hasOtherProfileCustomersboolean required
profileStoreCountinteger required
generationProfileIdstring uuid nullable required
generatedByRunIdstring uuid nullable required
source'generated' | 'manual' | 'connected' required
poolStatus'active' | 'retired' required
retiredAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
interviewEligibleboolean required
campaignNamestring required
latestDiscoveryResult'won' | 'lost' nullable required

Changes

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