Developer

Endpoints

Every endpoint shares this key's workspace rate limit. Access is learned from real responses during this session.

Token limit

Aggregate ceiling for this API key across all endpoints.

60RPM

default

10,000 requests / day (default)

Topics2

POST/v1/topics

Submit a topic (expand) or a fixed keyword list

Needs estimateShared · 60 RPM

GET/v1/topics/requests/{request_id}

Status of a topic request

Needs readShared · 60 RPM

Estimates2

POST/v1/estimate

Free audience estimate for keywords and ICP filters

Needs estimateShared · 60 RPM

GET/v1/topics/{topic_id}/estimate

Free estimate for a submitted topic

Needs estimateShared · 60 RPM

Quotes2

POST/v1/topics/{topic_id}/quotes

Quote the paid pull and enrichment for a topic (nothing is charged)

Needs estimateShared · 60 RPM

POST/v1/quotes/{quote_id}/approve

Approve a quote up to max_usd

Coming soon

Contacts1

GET/v1/topics/{topic_id}/contacts

Page the contacts for a topic (masked unless export scope and an approved quote)

Needs readShared · 60 RPM

Outcomes3

GET/v1/topics/{topic_id}/performance

Your outcomes for a topic (your workspace only)

Needs readShared · 60 RPM

POST/v1/topics/{topic_id}/feedback

Relevance or vendor feedback on a contact or company for a topic

Needs outcomesShared · 60 RPM

POST/v1/outcomes

Send campaign outcomes (stay in your workspace; never shared)

Needs outcomesShared · 60 RPM

Keys & usage5

GET/v1/usage

This workspace's usage

Needs ws_adminShared · 60 RPM

GET/v1/keys

This workspace's keys (never the secret)

Needs ws_adminShared · 60 RPM

POST/v1/keys

Issue a workspace key (plaintext returned once; scopes within the ceiling)

Needs ws_adminShared · 60 RPM

POST/v1/keys/{key_id}/rotate

Rotate a key (old key expires after the overlap, default 7 days)

Needs ws_adminShared · 60 RPM

DELETE/v1/keys/{key_id}

Revoke a key at once

Needs ws_adminShared · 60 RPM

Webhooks2

POST/v1/webhooks

Needs ws_adminShared · 60 RPM

DELETE/v1/webhooks/{webhook_id}

Remove a webhook endpoint

Needs ws_adminShared · 60 RPM

Privacy1

POST/v1/privacy_requests

Delete, access, suppress or withdraw-contribution request (30-day SLA)

Needs ws_admin or partner_adminShared · 60 RPM

Partner admin8

POST/v1/partner/workspaces

Create a workspace under your partner account

GET/v1/partner/workspaces

List your workspaces, status and limits

PATCH/v1/partner/workspaces/{workspace_ref}

Suspend or resume a workspace, or change its scope ceiling or limits (audited)

POST/v1/partner/workspaces/{workspace_ref}/keys

Issue a workspace key (plaintext returned once)

POST/v1/partner/keys/{key_id}/rotate

Rotate a workspace key

DELETE/v1/partner/keys/{key_id}

Revoke a workspace key at once

GET/v1/partner/usage

Your own usage across your workspaces

GET/v1/partner/audit

Audit log for your workspaces (redacted)