Find the row that matches what you want to do. It names the interface, the grant the API Key needs, and the page to start from. Every grant is chosen in one form, described in Create and use an API Key.
| You want to | Interface | Key grant | Start here |
|---|---|---|---|
| Read records a subscription has delivered | HTTP data API, GET /v1/live/pull | Data | Get your first authorized data |
| Export every delivered record of one Campaign | hb CLI, in a build your organization obtains by arrangement | Data | Export every delivered record |
| Read, create, or change a Campaign from a program | Campaign API, or the hb CLI | campaign:read to read; campaign:author to create or change | Campaign API |
| Launch a Campaign from a program | Campaign API or the hb CLI, plus a person's confirmation in the Developer portal | campaign:launch, with a spend cap | Launch a Campaign |
| Hand one bounded read to an external agent | HTTP data API, called by the agent | Data, narrowed to one subscription | Use an agent with Humanbased |
| Connect an MCP client | A tool server your organization supplies | The grant of the interface that server calls | MCP availability |
A Data grant and a CampaignA developer's data-production project and its settings grant are separate. A Key that reads delivered records cannot change a Campaign, and a Key that changes a Campaign reads a subscription's records only when it also holds Data.
Reference pages for work already under way:
- Retrieve delivered records: what each parameter and field of the data API means, and how to reconcile usage.
- Troubleshoot data retrieval API responses: which next action is safe for a status, or for a response that never arrived.
- Use the Humanbased CLI: how to obtain a build, point it at an environment, and read its exit codes.
Versions
Each path carries its version, such as /v1/live/pull or /api/v1/campaignapi/campaigns. This documentation covers the /v1/live/* data endpoints and the Campaign API. The older /v1/data/* endpoints read a legacy delivery model and are not documented here; build new integrations on /v1/live/*.