Skip to content
API reference/
API Reference
/
/
Get a Location

Get a Location

Request

Retrieve a single location by its ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Query
include[]Array of strings

Opts additional sets of locations into the lookup. By default an archived location is not found; include[]=archived retrieves it, identifiable by a non-null archived_at.

Items Value:"archived"
Example:include[]=include[]=archived
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/locations/{id}?include%5B%5D=include%5B%5D%3Darchived' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
namestringrequired
partner_site_namestring or nullrequired
aboutstring or nullrequired
emailstring or nullrequired
phone_numberstring or nullrequired
map_urlstring or nullrequired
latitudestring or nullrequired
longitudestring or nullrequired
no_availability_textstring or nullrequired
addressobject or nullrequired
archived_atstring or null, (date-time)required
created_atstring or null, (date-time)required
updated_atstring or null, (date-time)required
slot_countnumberrequired
next_available_atstring or null, (date-time)required
Response
{
  "id": "string",
  "name": "string",
  "partner_site_name": "string",
  "about": "string",
  "email": "string",
  "phone_number": "string",
  "map_url": "string",
  "latitude": "string",
  "longitude": "string",
  "no_availability_text": "string",
  "address": {
    "line_1": "string",
    "line_2": "string",
    "line_3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string"
  },
  "archived_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "slot_count": 0,
  "next_available_at": "2019-08-24T14:15:22Z"
}