Departments

The Department object is used to represent a department within a company.

The Department object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The department's name.

remote_dataRemoteData[]
Optional

The Department object

{
  "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "remote_id": "23456",
  "name": "Engineering",
  "remote_data": [
    {
      "path": "/departments",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/departments

Returns a list of Department objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
      "remote_id": "23456",
      "name": "Engineering",
      "remote_data": [
        {
          "path": "/departments",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

nameString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Greenhouse - Job Boards API

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString
GET

/departments/{id}

Returns a Department object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "remote_id": "23456",
  "name": "Engineering",
  "remote_data": [
    {
      "path": "/departments",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_idString

nameString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

Greenhouse - Job Boards API

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString

remote_idString