Skip to content

https://api.getarbol.com

API reference

Every endpoint of Arbol's products and of its integrations with insurers, registries and clinical systems, with its request, its response and code samples. New here? Make your first call in the quickstart.

The basics

  • Base URLhttps://api.getarbol.com/v1/<service>Each service below has its own path, such as /v1/raiz or /v1/sura.
  • AuthenticationAuthorization: Bearer <token>An API key or an OAuth access token. One credential works for every service. Get an API key
  • Responses{ success, data, error, metadata }JSON in the same envelope whether the call succeeds or fails. Responses and errors

Your first request: the organization your API key belongs to.

curl https://api.getarbol.com/v1/account/organization \
  --header "Authorization: Bearer $ARBOL_API_KEY"
  • TypeScriptnpm install @arbol-ai/sdk
  • Rustarbol-sdk (git dependency)
  • CLInpm install --global @arbol-ai/cli
  • MCPhttps://api.getarbol.com

Products

Patient contact, scheduling and the organization itself.

  • Raíz66 endpoints

    Contact with each patient: agents and their voices, channels, campaigns, templates and bulletins, conversations, contacts and profiles, the block list, knowledge, facts and definitions, tasks, evaluations and reports.

    ReferenceOpenAPI/v1/raiz

  • Agenda34 endpoints

    Scheduling: services and offerings, resources and locations, schedule rules, appointments, bookings and the waitlist.

    ReferenceOpenAPI/v1/agenda

  • Account29 endpoints

    The organization: members and invitations, API keys, connections, roles and permissions, billing, invoices and usage.

    ReferenceOpenAPI/v1/account

Integrations

Insurers, public registries and clinical systems, through your organization's connections to them. How integrations work

OpenAPI

Machine-readable specs for your tools. This reference matches API release 1.20261104.21009.

  • One servicehttps://docs.getarbol.com/api/<service>/openapi.jsonImport it into Postman or Insomnia, or generate a client. No credential needed.
  • The whole APIhttps://api.getarbol.com/openapi.jsonEvery service in one document, as the API serves it.
  • API cataloghttps://docs.getarbol.com/.well-known/api-catalogEach reference with its docs and OpenAPI document (RFC 9727), for tools and AI agents.

Escribe para buscar…

↑↓ navegar↵ seleccionarEsc cerrar