Developers
API reference
Run your outreach from your own code: campaigns, replies, mailboxes, lead lists, leads and search.
Authentication
- Create an API key in the app under Settings, then APIs (owners and admins).
- Send it on every request in the Authorization header as Bearer zk_your_key (or in an X-Api-Key header).
- A key is shown once. A read-only key can call every GET endpoint; POST, PATCH and DELETE need a read and write key.
- Every call acts on the one workspace the key belongs to.
Your first request
curl https://app.zicreach.com/api/v1/account -H "Authorization: Bearer zk_your_key"Pagination
Lists are paginated with page and per_page; the response has a meta object with current_page, last_page and total.
Response
{
"data": [
"..."
],
"meta": {
"current_page": 1,
"last_page": 4,
"total": 92
}
}Errors
Errors use standard HTTP status codes and a JSON body with a message.
| Status | Meaning |
|---|---|
401 | Missing or invalid key |
402 | Over the plan, for example more leads in one call than the plan allows (error is plan_limit) |
403 | Read-only key used for a change, or a key made by someone who is no longer an owner or admin |
404 | Not found in this workspace |
409 | Conflict, for example already running |
422 | Invalid input, or not ready; the body has message and an errors object, one entry per field |
429 | More than 120 requests a minute |
Example error422
{
"message": "The email field must be a valid email address.",
"errors": {
"email": [
"The email field must be a valid email address."
]
}
}Rate limits
At most 120 requests a minute. Over the limit, requests are refused with 429 until the minute is up.