# Public API – Practice & Location Management

Operations related to patients, appointments, providers and so on.

Version: 191.0.3

## Servers

Sandbox
```
https://test.hs1api.com/ascend-gateway/api
```

Prod
```
https://prod.hs1api.com/ascend-gateway/api
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### oAuthSandbox

OAuth 2.0 client credentials (Sandbox)

Type: oauth2
Token URL: https://test.hs1api.com/oauth/client_credential/accesstoken?grant_type=client_credentials
Scopes:

## Download OpenAPI description

 - [Public API – Practice & Location Management](https://papidocs.hs1api.com/_bundle/PublicAPI/api-practice-and-location-management.yaml)

 - [GET /v1/locationhours](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationhoursv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/locationhours](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/postlocationhoursv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/locationhours/{locationHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationhoursbylocationhouridv1.md): Returns the location hour (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/locationhours/{locationHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putlocationhoursbylocationhouridv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/locationhours/{locationHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/deletelocationhoursbylocationhouridv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/locationpovertylevels](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationpovertylevelsv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/locationpovertylevelsV1/{locationPovertyLevelId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationpovertylevelsv1bylocationpovertylevelidv1.md): Returns the location poverty level identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/locationpovertylevelsV1/{locationPovertyLevelId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putlocationpovertylevelsv1bylocationpovertylevelidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [GET /v1/locationproductionnetactual](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationproductionnetactualv1.md): Daily (or multi-day) net actual amounts by location. **Minimum valid `filter`:** `location.id`, `fromDate` (`YYYY-MM-DD`), `chargeAdjustments==true|false`, and `unappliedCredits==true|false` when neit
 - [GET /v1/locationproductionnetschedule](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationproductionnetschedulev1.md): Location Production Net Schedule report: one row per calendar day in the `range` starting at `fromDate`, with `scheduledAmount` aggregated from the organization’s scheduled production data. **Access:*
 - [GET /v1/locationproductionnetschedule/async](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationproductionnetscheduleasyncv1.md)
 - [GET /v1/locationproductiongross](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationproductiongrossv1.md): Each row covers one calendar day in the requested window. **actualAmount** is gross production recognized for that day; **scheduledAmount** is production scheduled for that day. Both may be zero when
 - [GET /v1/locations](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationsv1.md): **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry wi
 - [GET /v1/locations/{locationId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getlocationsbylocationidv1.md): Returns the LocationV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/locations/{locationId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putlocationsbylocationidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [GET /v1/operatories](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getoperatoriesv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/operatories](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/postoperatoriesv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/operatories/{operatoryId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getoperatoriesbyoperatoryidv1.md): Returns the OperatoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/operatories/{operatoryId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putoperatoriesbyoperatoryidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/operatories/{operatoryId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/deleteoperatoriesbyoperatoryidv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/providerhours](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getproviderhoursv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/providerhours](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/postproviderhoursv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/providerhours/{providerHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getproviderhoursbyproviderhouridv1.md): Returns the providerHour identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/providerhours/{providerHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putproviderhoursbyproviderhouridv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/providerhours/{providerHourId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/deleteproviderhoursbyproviderhouridv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/providers](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getprovidersv1.md): **Query shape:** Prefer a **narrow** filter—combine `location.id`, `user.id`, or `id` with `lastModified` bounds where possible. A very wide `lastModified` range with no other scoping can **408** (tim
 - [POST /v1/providers](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/postprovidersv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/providers/{providerId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/getprovidersbyprovideridv1.md): Returns the provider identified by the path parameter. **404** when the provider is missing or not accessible in the organization context.
 - [PUT /v1/providers/{providerId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/putprovidersbyprovideridv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [GET /v1/timeclocks](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/gettimeclocks.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/timeclocks](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/posttimeclocks.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/timeclocks/{timeClockId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/gettimeclocksbytimeclockid.md): Returns the timeClock identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/timeclocks/{timeClockId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/puttimeclocksbytimeclockid.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/timeclocks/{timeClockId}](https://papidocs.hs1api.com/publicapi/api-practice-and-location-management/other/deletetimeclocksbytimeclockid.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.