Merge ATS - Offices

Offices

The Office object is used to represent an office within a company. A given Job has the Office ID in its offices field.

The Office object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The office's name.

locationString

Optional

The office's location.

remote_was_deletedBoolean

Required

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

field_mappingsObject

Optional

modified_atString

Required

This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]

Optional

The Office object

JSON


{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "876556788",
  "name": "SF Office",
  "location": "Embarcadero Center 2",
  "remote_was_deleted": true,
Show advanced fields
}

GET

/offices

Returns a list of Office 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, only objects synced by Merge after this date time will be returned.

modified_beforeString

Optional

If provided, only objects synced by Merge before this date time will be returned.

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": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "remote_id": "876556788",
      "name": "SF Office",
      "location": "Embarcadero Center 2",
      "remote_was_deleted": true,
Show advanced fields
    }
  ]
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_dataRemoteData[]

pathstring

dataobject

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Personio Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

GET

/offices/{id}

Returns an Office 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": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "876556788",
  "name": "SF Office",
  "location": "Embarcadero Center 2",
  "remote_was_deleted": true,
Show advanced fields
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_dataRemoteData[]

pathstring

dataobject

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Personio Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

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

Offers

Next Up

Get Started

API Reference

Previous

Next Up