Departments

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

The Department object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The department's name.

remote_dataRemoteData[]

Optional

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted by third party webhooks.

The Department object

JSON


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

GET

/departments

Returns a list of Department objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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_deleted_dataBoolean

Optional

Whether to include data that was marked as deleted by third party webhooks.

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

JSON


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

Field support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Not seeing a platform that you're looking for? Submit a request for it here.

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/departments/{id}

Returns a Department object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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

JSON


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

Field support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Not seeing a platform that you're looking for? Submit a request for it here.

Hint: Use the /linked-accounts endpoint to pull platform support information.

Candidates

Next Up

Eeocs

Departments

The Department object

Properties

/departments

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

BambooHR

BizMerlinHR

Breezy

CATS

Cornerstone TalentLink

Freshteam

Greenhouse

Greenhouse - Job Boards API

HR Cloud

JazzHR

JobScore

Jobsoid

Jobvite

Lever

Oracle Taleo

Recruitee

Recruiterflow

Sage HR

SAP SuccessFactors

SmartRecruiters

TalentLyft

TalentReef

Teamtailor

UKG Pro Recruiting

Workable

Workday

/departments/{id}

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

BambooHR

BizMerlinHR

Breezy

CATS

Cornerstone TalentLink

Freshteam

Greenhouse

Greenhouse - Job Boards API

HR Cloud

JazzHR

JobScore

Jobsoid

Jobvite

Lever

Oracle Taleo

Recruitee

Recruiterflow

Sage HR

SAP SuccessFactors

SmartRecruiters

TalentLyft

TalentReef

Teamtailor

UKG Pro Recruiting

Workable

Workday

Previous

Next Up

Get Started

API Reference