Sign in
ats/departments

Retrieve Departments

Retrieve Departments from any connected Ats software

get/ats/departments/{id}

Path parameters

idstring required

id of the department you want to retrieve.

Query parameters

remote_databoolean

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

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable

The name of the department

field_mappingsobject nullable

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

idstring nullable

The UUID of the department

remote_idstring nullable

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

remote_dataobject nullable

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

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "name": "Sales",
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "key1": "value1",
    "key2": 42,
    "key3": true
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2023-10-01T12:00:00Z"
}

Changes