CirrusMD API Documentation

Repository for GiHub Pages hosted Developer Documentation

Customer API (/v2)

Welcome to the CirrusMD API! You can use our API to create and update patient records, as well as retrieve plan and progress note data. You will need to retrieve an access token first via the /oauth/token endpoint, provinding the Client ID and Secret that your Customer Success has representative provided.

Headers

CirrusMD expects 3 headers to be included in all Authenticated API requests inclusive of the following:

Authorization: Bearer <token>
Content-Type: application/json
Accept: application/json

Paging

Paging is supported on all collection resources. The page size is currently fixed at 50 items per page. Please inspect the links and meta keys in the response body, for specifics on navigating to the next page.

NOTE

Replace <base_url> from the examples below with one of the following:

Environment Base URL
Production https://api.cirrusmd.com
Sandbox https://api-sandbox.cirrusmd.com

GET <base_url>/v2/progress_notes?page=3

{
  "links": {
    "self": "<base_url>/v2/progress_notes?page=3",
    "prev": 2,
    "next": null
  },
  "meta": {
    "paging": {
      "total": 128
    }
  },
  "data": []
}