REST API quickstart

Steps

1. Create a key. Open Settings, then API & agents, and create a key. It is shown once, so store it safely.
2. Call the API. curl -H "Authorization: Bearer pp_..." https://YOUR-APP/api/v1/me returns your account and plan usage.
3. Add leads. POST /api/v1/leads for one, or POST /api/v1/leads/bulk for up to 1,000 at a time.
4. Build and start a campaign. POST /api/v1/campaigns creates a draft, POST /api/v1/campaigns/{id}/leads enrolls leads, POST /api/v1/campaigns/{id}/start starts it.
5. Read replies. GET /api/v1/threads lists conversations and GET /api/v1/threads/{id} reads one.

Good to know

• Each key is limited to 120 requests a minute.
• Plan limits apply to the API too. Going over returns 402 with the code plan_limit.
• Mailbox passwords are never returned by the API.
• Every API and MCP action is recorded in the audit log under Settings, API & agents.
• Interactive docs are at /api/docs in the app.