Introduction
Get to know the basics of the Turquoise Health API and how to put it to work.
Base URL
The Turquoise Health API is built on REST principles. We enforce HTTPS in every request to improve privacy, security and data integrity.
All requests must be made to the base URL:
https://lab.turquoise.health
Authentication
To authenticate, you will need to add an Authorization header with the contents of the header being Bearer d13f00e6b9d5where d13f00e6b9d5 is your API Key.
Authorization: Bearer TURQUOISE_API_KEY
warning
Calls made over plain HTTP will fail. API requests without authentication will also fail.
Response codes
Turquoise uses standard HTTP codes to indicate the success or failure of your requests.
In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.
| Status | Description |
|---|---|
| 200 | Successful request. |
| 400 | Check that the parameters were correct. |
| 401 | The API key used was missing. |
| 403 | The API key used was invalid. |
| 404 | The resource was not found. |
| 5XX | Indicates an error with Turquoise API servers. |