Public API

Showing 25 of 27 from the live probe.

• Get Audiences

  Get Audiences. Lists audiences visible to this API key. Restricted (scoped) keys only see audiences within their scopes. A segment-scoped key can still read `GET /segments/{segment_id}` for that segment even when this list is empty.

• Create Audience

  Create Audience

• Preview Audience

  Preview Audience. Preview the results and count of an audience based on filters before creating it.

• Create Custom Audience

  Create Custom Audience

• Enrich Contact

  Enrich contact

• Get Enrichments

  Get Enrichments. Retrieve a paginated list of enrichment jobs for the authenticated account

• Create Enrichment Job

  Create Enrichment Job. Upload enrichment records and enqueue a job for processing. **Supported fields** - `EMAIL` - `PERSONAL_EMAIL` - `BUSINESS_EMAIL` - `FIRST_NAME` - `LAST_NAME` - `PHONE` - `PERSONAL_ADDRESS` - `PERSONAL_CITY` - `PERSONAL_STATE` - `PERSONAL_ZIP` - `COMPANY_NAME` - `COMPANY_DOMAIN` - `COMPANY_INDUSTRY` - `SHA256_PERSONAL_EMAIL` - `LINKEDIN_URL` - `UP_ID` - `JOB_TITLE`

• Audience Lookup

  Audience lookup

• Audience Delete

  Audience delete

• Audience Attributes

  Audience Attributes

• Get Pixels

  Get Pixels

• Create Pixel

  Create Pixel

• Pixel Lookup V4

  Pixel lookup (V4). Retrieves pixel events (V4 format). Per-account rate limit: 30 requests/minute, burst 20. Prefer `page_size` up to 1000 to reduce request count, but serialize pulls across pixels and honor `Retry-After` — do not fire many large pages in parallel.

• Pixel Lookup

  Pixel lookup. Retrieves pixel events. Routes to V4 or legacy format based on the pixel's provider. Per-account rate limit: 30 requests/minute, burst 20. Prefer `page_size` up to 1000 to reduce request count, but serialize pulls across pixels and honor `Retry-After` — do not fire many large pages in parallel. Response schema depends on provider: v4 pixels return PixelFetchResponseV4; other providers return the legacy event shape with the same pagination envelope (total_records, page_size, page, t

• Pixel Delete

  Pixel delete

• Fetch A Saved Segment

  Fetch a saved segment. Returns a page of rows for a saved Studio segment. Audience-backed segments read the completed audience CSV. Pixel-backed segments read ClickHouse ordered by `EVENT_TIMESTAMP` descending (newest first). Server-side timeout is 55 seconds. When a page cannot be served in that window, or the segment backend is at capacity, the response is HTTP 429 with `Retry-After`. Retry the same page; do not treat 429 as a permanent failure. Recommended: client timeout ≥ 60s, at most 4 con

• Submit A Dsr Data Subject Rights Request

  Submit a DSR (Data Subject Rights) request. Submit an opt-out, deletion or data access request on behalf of an end user. Designed for white-label partners: the end user never interacts with this platform directly. The request enters the same fulfillment pipeline as the public Privacy Center form — real-time / API suppression within 24 hours, audience / data-license deliveries on the next scheduled refresh. Resubmitting the same partner_ref_id is idempotent and returns the original ticket with HT

• Pull Completed Dsr Records Since A Timestamp

  Pull completed DSR records since a timestamp. Returns the global opt-out/deletion suppression feed fulfilled since the given timestamp so you can sync hashed emails into your CRM or data pipeline between deliveries. Emails are SHA-256 hashes only. `dsr_id` is included only for requests your account submitted; other partners' ticket IDs are never exposed. Paginate with next_cursor.

• Check The Status Of A Dsr Request

  Check the status of a DSR request. Returns the current status of a request previously submitted with your API key. Requests submitted by other accounts are not visible.

• Fetch A Promoted Scored Segment

  Fetch a promoted scored segment. Returns one page of scored identities for a topic this account has promoted. Each row includes buyer stage and buyer score from the latest scoring snapshot. This is a new route and does not change GET /segments/{segment_id}, /audiences, or /pixels. `segment_id` is the promoted topic id (`mp_b2b_*`, `mp_b2c_*`, `custom_*`), not a Studio segment UUID. Paginate with `page` / `page_size` (max 1000). Honor 429 Retry-After. Default records are score-only. Pass `include

• Get Account Pixel Credits

  Get account pixel credits. Returns the caller's account-level pixel limits and usage. Clients cannot raise their own caps via API; limits are set by billing/admin or by a white-label host allocating from their pool.

• Get Whitelabel Host Pixel Pool

  Get white-label host pixel pool. Returns the host pool ceilings and sums already allocated to sub-teams. Requires the API key account to be a white-label host.

• List Whitelabel Subteams With Pixel Credits

  List white-label sub-teams with pixel credits. Lists sub-teams owned by the white-label host and their pixel credit fields.

• Update Subteam Pixel Credits

  Update sub-team pixel credits. Allocates or updates pixel caps for a sub-team (e.g. after an upsell). Only white-label hosts may call this. The projected sum allocated across all sub-teams must remain within the host pool. Existing over-allocation may be reduced but cannot be increased. End clients cannot raise their own caps. The Pixel create endpoint remains create-only and does not accept cap fields.

• List Signup Links

  List signup links. Lists the host's signup links (both dashboard- and API-created), newest first.