An institution represents a logical grouping of practices and their data sources. All practice based resources are members of an institution.

Working within an Institution

You can specify the institution you are working with by passing the subdomain name in the subdomain query parameter e.g. ?subdomain=example-subdomain. This locks the query to one specific institution. Most endpoints require that this parameter is specified. If you attempt to access an institution that you don't have access to, you will receive a 403 Forbidden response.

Institutions Response Object

  "code": false,
  "description": [
  "error": [
  "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",
    "widelogo_file_name": "string",
    "widelogo_content_type": "string",
    "widelogo_file_size": "string",
    "widelogo_updated_at": "string",
    "emrs": [
    "phone_extension": "string",
    "fax_number": "string",
    "fax_extension": "string",
    "is_sync_live": false,
    "is_client_live": false,
    "static_logo_url": "/images/missing.png",
    "country_code": "US",
    "is_appt_categories_location_specific": false,
    "is_sync_notifications": true,
    "notify_insert_fails": false,
    "locations": [
        "id": 7,
        "name": "Default"
  "count": 2