Sign in
hris/locations

Retrieve Location

Retrieve a Location from any connected Hris software

get/hris/locations/{id}

Path parameters

idstring required

id of the location you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Hris software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable

The name of the location

phone_numberstring nullable

The phone number of the location

street_1string nullable

The first line of the street address

street_2string nullable

The second line of the street address

citystring nullable

The city of the location

statestring nullable

The state or region of the location

zip_codestring nullable

The zip or postal code of the location

countrystring nullable

The country of the location

location_typestring nullable

The type of the location

company_idstring nullable

The UUID of the company associated with the location

employee_idstring nullable

The UUID of the employee associated with the location

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the location record

remote_idstring nullable

The remote ID of the location in the context of the 3rd Party

remote_dataobject nullable

The remote data of the location in the context of the 3rd Party

remote_created_atstring date-time nullable

The date when the location was created in the 3rd party system

created_atstring date-time nullable

The created date of the location record

modified_atstring date-time nullable

The last modified date of the location record

remote_was_deletedboolean nullable

Indicates if the location was deleted in the remote system

Example response

{
  "name": "Headquarters",
  "phone_number": "+1234567890",
  "street_1": "123 Main St",
  "street_2": "Suite 456",
  "city": "San Francisco",
  "state": "CA",
  "zip_code": "94105",
  "country": "USA",
  "location_type": "WORK",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "employee_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "location_1234",
  "remote_data": {
    "raw_data": {
      "additional_field": "some value"
    }
  },
  "remote_created_at": "2024-10-01T12:00:00Z",
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes