Skip to main content

​
Authentication

An API key is required to get started. Follow these steps:
  1. Sign up for a Ready Health account at https://app.readyhealth.com
  2. Navigate to the Settings tab and Developer section
  3. Generate a new API key
Store your API key securely. It won’t be displayed again after generation.
Requests are authenticated with the API (secret) key in the request header: 
x-api-key: YOUR_API_KEY

​
Example

cURL
curl --request POST \
     --url 'https://api.readyhealth.com/document/{id}' \
     --header 'Accept: application/json' \
     --header 'x-api-key: YOUR_API_KEY'

​
Sandbox Test Environment

We offer a sandbox developer API environment at api-sandbox.readyhealth.com that enables testing the functionality of api.readyhealth.com. The sandbox requires a separate API key that is available in the Settings page of the Admin Dashboard. Once you have your Sandbox API key, you can immediately start testing our API, either from our API Reference or from your development environment. We aim for high parity between the sandbox and production environment. However, there may be differences in performance and latency. New features are released first to the sandbox environment before general release to production.

​
Status Codes

Status CodeDescription
200Request is Successful
201Resource Created
400Invalid Request
401Invalid Authentication
403Invalid Permissions
404Resource not found
5XXInternal Server Error
The error response also contains a descriptive message to communicate the issue. 
{
     "statusCode": 404,
     "message": "Cannot DELETE /document/123",
     "error": "Not found" 
}