Offices

The Office object is used to represent an office within a company.

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 on the third-party.

The Office object

JSON


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

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 deleted in the third-party service.

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_was_deleted": true
    }
  ]
}

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

nameString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

nameString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

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
}

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

nameString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

nameString

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString

nameString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

locationString

remote_idString

nameString

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

Offers

Next Up

Reject Reasons

Offices

The Office object

Properties

/offices

Header Parameters

Query & Path Parameters

Oracle Taleo

Ashby

Breezy HR

Teamtailor

Greenhouse

Workable

Jobsoid

CATS

SAP SuccessFactors

Freshteam

Clockwork

TalentLyft

ApplicantStack

Sage HR

Recruitee

SmartRecruiters

Greenhouse - Job Boards API

Jobscore

JazzHR

Recruiterflow

Jobvite

Lever

HR Cloud

BambooHR

TalentReef

UKG Pro Recruiting

Workday

Fountain

/offices/{id}

Header Parameters

Query & Path Parameters

Oracle Taleo

Ashby

Breezy HR

Teamtailor

Greenhouse

Workable

Jobsoid

CATS

SAP SuccessFactors

Freshteam

Clockwork

TalentLyft

ApplicantStack

Sage HR

Recruitee

SmartRecruiters

Greenhouse - Job Boards API

Jobscore

JazzHR

Recruiterflow

Jobvite

Lever

HR Cloud

BambooHR

TalentReef

UKG Pro Recruiting

Workday

Fountain

Previous

Next Up

Get Started

API Reference