---
updatedAt: 2026-10-01T07:35:41.000Z
agentTools:
  projectIndex: https://docs.nexhealth.com/llms.txt
---

# Locations

<p style="display: none">**API Version:** This document applies to **v3.0.0**, also referred to as **v20240412**, of the API.</p><br /><br />A location represents a physical practice through which all patient interactions occur; e.g. patient communication, booking an appointment, new patient intake.

API access is provided on a per location basis. You can add or submit other locations for installation in the [Developer Portal](https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal).

Resources that exist within a location require that you provide a location id as a parameter in each request. Specifying a location id that doesn't exist within the institution will result in a `404 Not Found` response.

> 📘 Store subdomains and locations Ids
>
> Since you will likely be providing the subdomain and location\_id in your requests often and these values are unlikely to change, it is a good idea to periodically perform a GET request to `/locations` and store the response data for reuse.

## Locations response

```json
{
  "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": "defaultLocation@nexhealth.com",
          "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
}
```

<br />