Directory API

Introduction to the API

The Directory API is a CRUD API that allows you manage your own healthcare resources. There are multiple types of health resources, which all have their own attributes. In addition to attributes, resources can also have relationships to other health resources in your directory. Here are the available resource types you can manage:


The REST API lets you interact directly with Clinia from anything that can send an HTTP request. All API accesses must use HTTPS. The primary host is


The entire API uses JSON:API encoded as UTF-8. JSON:API is a specification for building standardized JSON APIs. Requests and responses content are normalized and allow for thorough resource definition. We recommend you look over the specification before using the API, so you get a good grasp of the basics before using the API.

The body of POST and PATCH requests must be a JSON object and their Content-Type header should be set to application/vnd.api+json.

The body of responses is always a JSON object, and their content type is always application/vnd.api+json.


All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

For javascript usage, Cross-origin Resource Sharing (CORS) is supported by the API so that you can use XMLHttpRequest.