Sign in
hris/locations

List Locations

get/hris/locations

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "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