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>'
import requests

url = "https://api.bindbee.dev/api/ats/v1/offices/{id}"

headers = {
"x-connector-token": "<x-connector-token>",
"Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'x-connector-token': '<x-connector-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.bindbee.dev/api/ats/v1/offices/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bindbee.dev/api/ats/v1/offices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-connector-token: <x-connector-token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.bindbee.dev/api/ats/v1/offices/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-connector-token", "<x-connector-token>")
req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/ats/v1/offices/{id}")
.header("x-connector-token", "<x-connector-token>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/ats/v1/offices/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

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 | null
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 | null

This is the Raw data

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