Locations

A location is a physical practice. All patient interactions happen through a location, such as patient communication, booking an appointment and new patient intake.

API access is granted per location. You can add other locations, or submit them for installation, in the Developer Portal.

Resources inside a location need a location ID as a parameter in each request. A location ID that does not exist in the institution returns 404 Not Found.

📘
Store subdomains and location IDs
You send subdomain and location_id in most requests, and these values rarely change. Call GET /locations from time to time and store the response for reuse.

Locations response

{
  "code": false,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data":  {
      "id": 1,
      "name": "General Practice - Dr. P. Sherman DDS",
      "subdomain": "example-subdomain",
      "locations": [
        {
          "id": 7,
          "name": "Default",
          "institution_id": 1,
          "street_address": "123 Law St",
          "street_address_2": "85335, North East",
          "city": "New York",
          "state": "NY",
          "zip_code": "54700",
          "created_at": "2020-06-05T20:16:57.007Z",
          "updated_at": "2020-06-05T20:16:57.007Z",
          "latitude": 37.7775028,
          "longitude": -122.3970603,
          "phone_number": "8888750851",
          "foreign_id": "1",
          "foreign_id_type": "--DataSource-",
          "email": "[email protected]",
          "tz": "America/Los_Angeles",
          "last_sync_time": "2020-06-17T19:23:49.176Z",
          "insert_appt_client": "true",
          "map_by_operatory": "true",
          "set_availability_by_operatory": false,
          "inactive": "false"
        }
      ]
    },
  "count": 2
}