TeleClinic Partner API
The TeleClinic Partner API allows you to embed the services of TeleClinic into your application. Please reach out to us for getting access.
Our guides and reference documentation now live at docs.teleclinic.com. This page only serves the OpenAPI specification of each version.
OpenAPI specification
Browse the latest OpenAPI specification at docs.teleclinic.com/reference/openapi.html.
Go directly to the specification of a specific version
- v1/: OpenAPI
Authentication
New here? Learn how to authenticate your users, for example by exchanging a token from your own identity provider for a TeleClinic token, or by logging users in through the browser.
Versioning policy
Our API follows the MAJOR.MINOR versioning schema. Major versions break compatibility and stay
available side by side at different paths. Minor versions change the OpenAPI schema but always remain
backwards compatible. The documentation explains what counts as a breaking change.
Extensible enums
The OpenAPI spec cannot express whether an enum is extensible. Some enums in responses may receive new
values in MINOR versions, so your client must be able to handle unexpected values.
The reference lists which enums are extensible and suggests how to handle them.
