Arzamed API
Build integrations on top of Arzamed — the cloud platform that powers scheduling, medical records and billing for clinics and healthcare professionals.
The Arzamed external API lets partner systems read live data from a clinic's Arzamed account: practitioners, appointment slots, and patient records. Each clinic generates its own API credentials and authorises your system to access their data using the OAuth2 client credentials flow.
Credentials are issued per clinic. Each clinic generates their own client_id and client_secret from their Arzamed account. Contact the clinic's administrator to obtain credentials before you start.
Choose your path
Quickstart
From credentials to your first authenticated response in under five minutes.
Authentication
How to exchange credentials for an access token and attach it to requests.
API Reference
Endpoint details, parameters and example responses.
Conventions
Error codes and other shared behaviours.
Base URL & versioning
All API requests are made over HTTPS to a single, versioned base URL. The current version is v1.
Breaking changes are released under a new major version. Additive, backwards-compatible changes (new fields, new endpoints) may ship within the current version — write integrations that ignore unknown JSON fields.
A sandbox environment is available at https://api-uat.nextgen.arzamed.com/api/v1. Use it for integration testing with UAT credentials provided by the clinic's Arzamed administrator.
Requests & responses
The API follows REST conventions: resource-oriented URLs, standard HTTP verbs, and JSON responses. All requests must include a valid Authorization header.
curl https://api.nextgen.arzamed.com/api/v1/equipe/doctors \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Successful responses use standard 2xx status codes and return a JSON body. List endpoints return a plain JSON array:
[
{
"name": "Dr. Marco Bianchi",
"profileImage": "https://assets.arzamed.com/photos/abc123.jpg"
}
]
Errors
Arzamed uses conventional HTTP status codes to indicate the outcome of a request.
| Status | Meaning |
|---|---|
401 | Unauthorized — missing or invalid access token. |
403 | Forbidden — the token does not have access to this resource (wrong equipe, revoked, or expired key). |
503 | Service Unavailable — a downstream service is temporarily unreachable. Retry with exponential back-off. |
Error responses have a consistent shape:
{
"error": "Service unavailable"
}