Skip to main content
GET
/
api
/
ats
/
v1
/
offices
/
{id}
Get Office By Id
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/offices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "San Francisco",
  "location": "1234 Main Street, San Francisco, CA 94111",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

Include raw data in the response Include raw data in the response

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response. Whether to include custom fields in the response.

​
expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

Successful Response

The AtsOffice object represents an office or physical location of the company in the ATS.

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}
​
name
string | null
required

The name of the office.

Example:

"San Francisco"

​
location
string | null
required

The physical location or address of the office.

Example:

"1234 Main Street, San Francisco, CA 94111"

​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}