Institutions

An institution is a group of practices and their data sources. Every practice resource belongs to an institution.

Working within an institution

Pass the institution's subdomain in the subdomain query parameter, for example ?subdomain=example-subdomain. This locks the request to one institution. Most endpoints require this parameter. A request for an institution you cannot access returns 403 Forbidden.

Institutions response object

{
  "code": true,
  "description": null,
  "error": null,
  "data": {
      "id": 1,
      "name": "General Practice",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "subdomain": "example-sandbox",
      "phone_number": "2222222222",
      "emrs": [
        "dentrix",
        "curve2"
      ],
      "country_code": "US",
      "appointment_types_location_scoped": false,
      "is_sync_notifications": true,
      "notify_insert_fails": false,
      "locations": [
        {
          "id": 7,
          "name": "Default"
        }
      ]
    },
  "count": null
}