Getting started
How to connect
Pick the door that matches where your code lives, then make your first call.
All three doors open into the same place. What differs is where your code lives.
Your assistant. Self-service, no code, two minutes.
Your backend. One key, curl, done.
Your automations. OAuth, no key to store.
MCP — connect an assistant
Nobody at Orkasa registers your app: discovery and registration are automatic (RFC 9728 and RFC 7591).
Add the connector
In Claude: Settings → Connectors → Add custom connector. Paste:
https://orkasa.app/api/mcp
Authorize
Orkasa opens, you sign in with your usual account and approve the permissions. Every permission can be unchecked; the assistant only ever sees what you leave checked.
Ask
"What do I have today?" · "How is the Felipe deal going?" · "Book Thursday at 4pm with Ana at the El Cangrejo apartment."
The full flow — and why open registration is safe — is in Connect an assistant.
API — first call
API keys are issued by Orkasa, per brokerage. Write to us through the
contact form and you get your ork_live_… with the
permissions you asked for.
The key is shown once. Only a SHA-256 digest of it is stored, so there is no way to recover it: if it is lost, it is revoked and a new one is issued.
export ORKASA_KEY="ork_live_…"
export ORKASA_API="https://orkasa.app/api/v1"
curl "$ORKASA_API/me" -H "Authorization: Bearer $ORKASA_KEY"
{
"brokerage_id": "0d1f…",
"brokerage_name": "Casa Móvil Panamá",
"scopes": ["leads:read", "leads:write", "operations:read"]
}
GET /me is the one flat response in the API: no data envelope, because
Zapier uses it as-is to label the connection. Everything else follows the
standard envelope.
Now create a lead — a contact, a lead and its open operation, in one call:
curl -X POST "$ORKASA_API/leads" \
-H "Authorization: Bearer $ORKASA_KEY" \
-H "Content-Type: application/json" \
-d '{
"full_name": "Ana Torrijos",
"phone": "+507 6123 4567",
"origin": "web",
"budget_max": 250000,
"bedrooms_min": 2,
"operation_type": "buy"
}'
The operation_id that comes back is the thread everything else hangs from.
Continue in Lead to viewing.
Zapier
The Orkasa Zapier app runs on this same API, with OAuth instead of a key: you authorize once and Zapier refreshes its own access.
It ships Create Lead as an action, Find Lead as a search, and five triggers — among them the four state-change webhooks.
A typical inbound Zap: Gmail — new email in the agency inbox → Orkasa —
Create Lead with origin: "email" and the mail body in email_body. The
lead arrives already qualified by the AI.