Skip to content
API reference/
/Locations

Locations

List, retrieve, create, update, and archive locations for a practice group.

Operations

List Locations

Request

Retrieves a list of the locations configured for a practice group on Hero Health.

Security
apiKeyAuth and practiceGroupId
Query
appointment_type_idsArray of strings
has_availabilityboolean
searchstring

Case-insensitive partial match on the location's name or its partner_site_name, so a location can be found by either the name patients see or the site name it carries in the partner system.

include[]Array of strings

Opts additional sets of locations into the response. Repeatable and combinable. By default only active locations are returned; include[]=archived adds archived locations, identifiable by a non-null archived_at.

Items Value:"archived"
Example:include[]=include[]=archived
order_bystring

Field to sort by. name sorts alphabetically, ignoring case; slot_count sorts by the number of available slots. Defaults to the practice group's configured location order.

Enum:"name""slot_count"
order_descendingstring

Sort direction. To list the locations with the most availability first, use order_by=slot_count&order_descending=true.

Default:"false"
Enum:"true""false"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/locations?appointment_type_ids=string&has_availability=true&search=string&include%5B%5D=include%5B%5D%3Darchived&order_by=name&order_descending=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
countnumberrequired
Response
{
  "data": [
    { … }
  ],
  "count": 0
}