business

List profiles

List the organization's active business profiles a campaign can launch under (each with finished research), most recently researched first: each profile's id, route key, display name, website, and how many current store profiles it has, the stores a physical-location campaign interviews (0 when it has none). Pass include current for every active profile, researched or not, or include all for every profile, archived and unresearched included.

get/api/v1/business/profiles

Request

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

Number of items to return (1–1000)

cursorstring

Opaque cursor returned as nextCursor by the previous page

include'active' | 'current' | 'all'

active (the default): profiles a campaign can launch under, each with finished research; current: every active profile, researched or not; all: every profile, archived and unresearched included

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.