Skip to main content
Choose a section below to open its endpoint documentation. Each link opens a starting endpoint in the API endpoints tab, where you can browse related operations in the sidebar.

Before making requests

Confirm the API host, credentials, and permissions assigned to your integration. Use each endpoint’s parameters, authentication requirements, and response schema to prepare your request. The api.example.test host shown in code examples is a placeholder. Replace it with the host supplied by Nimbo, and include /api/v1 only once when combining your base URL and endpoint path.

Responses and errors

Check the HTTP status code before reading the response body. Response roots and fields vary by endpoint. Some definitions do not yet include every response field or error case; confirm any behavior your integration depends on with Nimbo.

OpenAPI files

Download the specifications for catalogs and sites, the core API, ERP, billing, patient portal, and webhooks. This site provides reference pages without an interactive request runner. Make requests using your own development tools and the environment agreed for your integration.

Integration workflows

Use the guides to connect individual operations into a workflow: patients, appointments, patient portal, charges and invoicing, and webhooks. Read Request conventions for shared guidance and endpoint-specific exceptions.