Empezar
La API v1
REST sobre HTTPS: ocho recursos, dos credenciales intercambiables, webhooks salientes.
https://orkasa.app/api/v1
Es sobre esta API que corre la integración de Zapier, y es la que comparte núcleos con el conector MCP.
Autenticación
Se aceptan dos credenciales, y son intercambiables en todas partes:
| Cabecera | Para | |
|---|---|---|
| Clave de API | Authorization: Bearer ork_live_… | un corredor automatizando su propia cuenta |
| OAuth 2.0 | Authorization: Bearer ork_at_… | una aplicación de terceros actuando en su nombre |
Las dos se resuelven al mismo contexto de agencia y permisos, así que cada endpoint se comporta igual con cualquiera de ellas. Ver Claves de API y OAuth 2.0.
El envoltorio de respuesta
Éxito:
{ "data": { "…": "…" }, "meta": { "next_cursor": null, "limit": 25 } }Error:
{ "error": { "code": "validation_error", "message": "…", "details": [] } }code es el contrato — ramifica sobre él, no sobre el estado HTTP ni sobre el
mensaje. La tabla completa está en Errores.
Dos endpoints responden planos, sin envoltorio, porque Zapier guarda el
cuerpo entero: GET /me y POST /hooks.
Paginación
Los endpoints de lista aceptan ?limit (por defecto 25, máximo 100) y
?cursor, un cursor de clave sobre created_at, id descendente. Devuelve
meta.next_cursor como ?cursor= para pedir la página siguiente; null es el
final.
Es un cursor de clave, no un desplazamiento: no repite ni se salta filas cuando alguien inserta un lead mientras recorres la lista.
Los recursos
| Recurso | Endpoints |
|---|---|
leads | listar · ver · crear · actualizar · archivar |
operations | listar · ver · crear · actualizar |
properties | listar · ver · crear · actualizar |
viewings | listar · ver · crear · actualizar |
offers | listar · ver · crear · actualizar |
documents | listar |
signatures | listar |
agents | listar |
hooks | suscribir · dar de baja · muestra |
Los cuerpos son estrictos
Un campo que la API no conoce devuelve 422, no se ignora en silencio. Las
columnas de sistema —brokerage_id, id, las marcas de tiempo,
public_slug— no se alcanzan desde ningún cuerpo.
Límite de peticiones
120 por minuto y por credencial. Ver Límites de uso.