Appearance
The Yapii API
Yapii has an API, so software you or a developer writes can read and change your workspace's data. Yapii publishes the full details at yapii.com/developers, and this page is a short summary of what you'll find there.
Who this is for
This one is for developers, or for a tool that can call an API for you. If you just want to connect Yapii to software it already supports, use Integrations instead.
Check your plan before you build
Yapii's pricing page shows API access in the Expansion column of its plan comparison table, and not in the Operator or Builder columns. That page is where the current answer lives, so check it there, or ask whoever looks after your billing, before you build anything against the API.
What it is
The developer page describes a REST API with API-key authentication, predictable JSON responses and idempotent writes. It's meant for pulling contact data into your own tools, triggering campaigns, and automating the rest of your workflow.
There's no separate sign-in step to set up. A key and one header are all a request needs.
Getting a key
Keys come from your own workspace, on the Developer page in Settings. That page covers naming a key, choosing Read or Write, and copying the key before it disappears.
The developer page notes that a Yapii key starts with zk_live_, which is a quick way to tell one from another tool's key.
Every request carries the key in an Authorization header, as a Bearer token. The developer page says that header is required for every endpoint except its public status feed.
What you can reach
The developer page groups the API by the kind of thing each part works with:
| Group | What it covers |
|---|---|
| Contacts | Create, read, update, delete and bulk-import contacts, with full-text search, custom fields and tag management. |
| Campaigns | Trigger email and SMS campaigns, check delivery status, and pull engagement analytics for a campaign. |
| Signals | Query behavioral signals and seller-score inputs attached to a contact. Read only. |
| Agents | Manage AI agent settings, hand-offs and team assignments, and build your own orchestration on top of Claire. |
| API Keys | List and revoke your workspace's keys from code. Needs the owner or admin role. |
| Billing | Retrieve plan limits, usage counters and checkout links for managing your subscription. |
Good to know
- A key covers the whole workspace. One key can reach all of that workspace's contacts, campaigns and settings, so treat it like a password. Developer has the rules for looking after keys.
- Read or write. Read suits data pipelines; write is for automations that create or update records.
- There's a rate limit. The developer page gives it as 120 requests a minute per key, and says the response tells your code how much it has left and when to try again.
- Revoking a key takes effect immediately, and it doesn't affect your other keys.
- Responses are paginated JSON, timestamps are ISO 8601 in UTC, and errors come back with standard HTTP status codes.
The full reference
yapii.com/developers carries the complete reference, generated from the API's own OpenAPI description, with a Try it out button that runs a real request using your own key. It also has copy-and-paste examples for cURL, JavaScript and Python.
Where this page gets its facts
Everything above is a summary of yapii.com/developers. Where this page and that one disagree, believe the developer page, and tell the Yapii team so we can fix this one.