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_dataRemoteData[]
Optional

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

field_mappingsObject
Optional

The Office object
JSON
{
"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
"remote_id": "876556788",
"name": "SF Office",
"location": "Embarcadero Center 2",
"remote_data": [
{
"path": "/locations",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

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, 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": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
"remote_id": "876556788",
"name": "SF Office",
"location": "Embarcadero Center 2",
"remote_data": [
{
"path": "/locations",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
]
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Greenhouse

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

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

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

remote_dataRemoteData[]
pathstring
dataobject

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Personio Recruiting

Personio Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

TalentReef

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

UKG Pro Recruiting

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Workday

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_data": [
{
"path": "/locations",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Greenhouse

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

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

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

remote_dataRemoteData[]
pathstring
dataobject

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Personio Recruiting

Personio Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

TalentReef

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

UKG Pro Recruiting

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationString

nameString

remote_dataRemoteData[]
pathstring
dataobject

Workday

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.