Offices
The
Office object is used to represent an office within a company. A given Job has the Office ID in its offices field.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringThe office's name.
locationStringThe office's location.
remote_was_deletedBooleanIndicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/offices
https://api.merge.dev/api/ats/v1/offices
US
EU
APAC
Returns a list of Office objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
Ashby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Breezy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
CATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
Comeet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Crelate
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastringremote_idString
d.Vinci
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Fountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Freshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Gem
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Greenhouse Job Board API
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
HR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
iCIMS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_idString
JazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
JobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jobsoid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Jobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Join
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastring
Oracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Personio Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationString
Recruiterflow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Sage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
SmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
Taleez
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastring
TalentLyft
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
TalentReef
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
Teamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Tellent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastring
UKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Welcome to the Jungle
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Workable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameString
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/offices/{id}
https://api.merge.dev/api/ats/v1/offices/{id}
US
EU
APAC
Returns an Office object with the given id.
Query & path parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringAshby
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringBambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringBreezy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringCATS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringComeet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringCrelate
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastringremote_idStringd.Vinci
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringFreshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGem
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringGreenhouse Job Board API
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringHR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringiCIMS
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_idStringJazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringJobScore
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJobsoid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringJoin
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringLever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastringOracle Taleo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringPersonio Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringRecruiterflow
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringSage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringTaleez
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringremote_dataRemoteData[]pathstringdatastringTalentLyft
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTalentReef
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringTeamtailor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTellent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringUKG Pro Recruiting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringWelcome to the Jungle
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idStringWorkable
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
locationStringnameStringremote_dataRemoteData[]pathstringdatastringremote_idString