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

idUUID
Required

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

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

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 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_mappingsObject
Optional

remote_dataRemoteData[]
Optional


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.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean
Optional
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_sizeInteger
Optional
Number of results to return per page.

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

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
CATS
CATS
Comeet
Comeet
Fountain
Fountain
Freshteam
Freshteam
Greenhouse
Greenhouse
Greenhouse - Job Boards API
Greenhouse - Job Boards API
HR Cloud
HR Cloud
iCIMS
iCIMS
JazzHR
JazzHR
JobScore
JobScore
Jobsoid
Jobsoid
Jobvite
Jobvite
Join
Join
Lever
Lever
Oracle Taleo
Oracle Taleo
Personio Recruiting
Personio Recruiting
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
TalentLyft
TalentLyft
TalentReef
TalentReef
Teamtailor
Teamtailor
Tellent
Tellent
UKG Pro Recruiting
UKG Pro Recruiting
Welcome to the Jungle
Welcome to the Jungle
Workable
Workable
Workday
Workday
GET
/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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Ashby
Ashby
BambooHR
BambooHR
Breezy
Breezy
CATS
CATS
Comeet
Comeet
Fountain
Fountain
Freshteam
Freshteam
Greenhouse
Greenhouse
Greenhouse - Job Boards API
Greenhouse - Job Boards API
HR Cloud
HR Cloud
iCIMS
iCIMS
JazzHR
JazzHR
JobScore
JobScore
Jobsoid
Jobsoid
Jobvite
Jobvite
Join
Join
Lever
Lever
Oracle Taleo
Oracle Taleo
Personio Recruiting
Personio Recruiting
Recruiterflow
Recruiterflow
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Taleez
Taleez
TalentLyft
TalentLyft
TalentReef
TalentReef
Teamtailor
Teamtailor
Tellent
Tellent
UKG Pro Recruiting
UKG Pro Recruiting
Welcome to the Jungle
Welcome to the Jungle
Workable
Workable
Workday
Workday