Sign in
hris/companies

Retrieve Company

Retrieve a Company from any connected Hris software

get/hris/companies/{id}

Path parameters

idstring required

id of the company 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

legal_namestring nullable

The legal name of the company

locationsstring[] nullable

UUIDs of the of the Location associated with the company

display_namestring nullable

The display name of the company

einsstring[] nullable

The Employer Identification Numbers (EINs) of the company

field_mappingsobject nullable

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

idstring nullable

The UUID of the company record

remote_idstring nullable

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

remote_dataobject nullable

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

remote_created_atstring date-time nullable

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

created_atstring date-time nullable

The created date of the company record

modified_atstring date-time nullable

The last modified date of the company record

remote_was_deletedboolean nullable

Indicates if the company was deleted in the remote system

Example response

{
  "legal_name": "Acme Corporation",
  "locations": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "display_name": "Acme Corp",
  "eins": [
    "12-3456789",
    "98-7654321"
  ],
  "field_mappings": {
    "custom_field_1": "value1",
    "custom_field_2": "value2"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "company_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