Get Eeoc By Id

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/eeocs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

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

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/ats/v1/eeocs/{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/eeocs/{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: <api-key>"
  ],
]);

$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/eeocs/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "submitted_at": "2021-01-01T00:00:00Z",
  "race": "WHITE",
  "gender": "MALE",
  "veteran_status": "DISABLED_VETERAN",
  "disability_status": "YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

GET

api

ats

eeocs

{id}

Get Eeoc By Id

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/eeocs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Connector-Token: <api-key>'

import requests

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

headers = {
    "Authorization": "Bearer <token>",
    "X-Connector-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Connector-Token': '<api-key>'}
};

fetch('https://api.bindbee.dev/api/ats/v1/eeocs/{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/eeocs/{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: <api-key>"
  ],
]);

$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/eeocs/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Connector-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Connector-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "submitted_at": "2021-01-01T00:00:00Z",
  "race": "WHITE",
  "gender": "MALE",
  "veteran_status": "DISABLED_VETERAN",
  "disability_status": "YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

default:<BINDBEE_API_KEY>

required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token

string

header

default:<CONNECTOR_TOKEN>

required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Path Parameters

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

expand

string | null

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The AtsEEOC object represents the Equal Employment Opportunity Commission (EEOC) related data for a candidate within the ATS.

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<date-time>

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"
}

candidate

any | null

required

The candidate associated with the EEOC data.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

submitted_at

string | null

required

The ISO date string when the EEOC data was submitted.

Example:

"2021-01-01T00:00:00Z"

race

string | null

required

The race of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"WHITE"

gender

string | null

required

The gender of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"MALE"

veteran_status

string | null

required

The veteran status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"DISABLED_VETERAN"

disability_status

string | null

required

The disability status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY"

raw_data

Raw Data · object | null

This is the Raw data

Example:

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

API Basics

Platform

HR & Payroll (HRIS)

Recruiting (ATS)

Learning (LMS)

Get Eeoc By Id

Authorizations

Path Parameters

Query Parameters

Response