healthcare
location

Retrieve a location

Changed on
get/healthcare/{connection_id}/location/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/healthcare/{connection_id}/location/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Location

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the location

created_atstring date-time

When the location record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the location record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Name of the location

descriptionstring

Description of the location

parent_idstring

The location this one is part of (e.g. a department within a hospital)

organization_namestring

Name of the organization that manages the location

latitudenumber

Latitude of the location

longitudenumber

Longitude of the location

is_activeboolean

Whether the location is in active use

rawobject

Raw data from integration

Changes