Skip to main content

Directory API

Introduction to the API#


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 encoded as UTF-8.

The body of POST, PATCH and PUT requests must be a JSON object and their Content-Type header should be set to application/son.

The body of responses is always a JSON object, and their content type is always application/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.

Error Handling#

All endpoints can return errors. Some error responses will come with a response body with more detail on the error.

Status CodeDescription
400 - Bad RequestThe request was malformed or not contained unexpected content.
401 - UnauthorizedAuthentication failed.
404 - Not FoundResource not found.
422 - Unprocessable EntityRequest was understood by the server but could not be processed, probably due to validation errors or invalid values.

Error response#

statusIntegerStatus code.
messageSymbolGeneric error message.
errorsArray<ErrorMessage>List of errors.

Error Message#

codeIntegerSpecific error code.
typeSymbolType of error.
messageSymbolError message.
fieldSymbolField that caused the error in the incoming request body.