Skip to content

Concepts

How the Arbol API is laid out, and the rules every call shares.

Updated

The Arbol API is one host, https://api.getarbol.com, with several services: Arbol’s products (Raíz, Agenda, Account) and integrations with insurers, registries and clinical systems. Whatever the service, a call follows the same rules, which these pages describe.

How the API is laid out

  • Paths. Each service’s operations live under /v1/<service>/, such as /v1/account/organization. Take the method and path from the API reference: they don’t always mirror the operation’s name, and some reads use POST.
  • Operation names. Every operation is named <service>.<resource>.<verb>, such as account.organization.get. The API reference, the SDKs and the MCP tools are all named after it.
  • OpenAPI. The whole API is described at https://api.getarbol.com/openapi.json, and each service at https://api.getarbol.com/v1/<service>/openapi.json. Both are public. GET https://api.getarbol.com/ lists them.
  • Credentials. Every call carries one credential in the Authorization header. See Authentication.

The rules every call shares

Type to search…

↑↓ navigate↵ selectEsc close