Get Candidates - Bindbee Docs

GET

api

ats

candidates

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "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"
      },
      "first_name": "John",
      "last_name": "Doe",
      "company": "Google",
      "title": "SOFTWARE ENGINEER",
      "last_interaction_at": "2021-07-01T00:00:00Z",
      "is_private": true,
      "can_email": true,
      "locations": [
        "San Francisco",
        "New York"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "email_addresses": [
        "john@doe.com"
      ],
      "urls": [
        {
          "type": "LINKEDIN",
          "value": "https://www.linkedin.com/in/johndoe"
        }
      ],
      "tags": [
        "JUNIOR",
        "INTERMEDIATE"
      ],
      "applications": [
        "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
      ],
      "attachments": [
        "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
      ],
      "remote_created_at": "2021-07-01T00:00:00Z",
      "remote_updated_at": "2021-07-01T00:00:00Z",
      "avatar": "https://www.example.com/avatar.jpg"
    }
  ]
}

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

Query Parameters

remote_id

string

The third-party API ID of the matching object.

company_id

string

If provided, will only return candidate for this company

include_raw_data

boolean

default:

false

Include raw data in the response

include_custom_fields

boolean

default:

false

Whether to include custom fields in the response.

page_size

integer

default:

Number of results to return per page. Maximum size is 100.

Required range: 1 < x < 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Response

200

application/json

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

page_size

integer

required

Indicates the count of items in the response

items

object[]

required

items.id

string

required

items.remote_id

string | null

required

The third-party API ID of the matching object.

items.modified_at

string

required

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

items.custom_fields

object | null

required

The custom fields related to the model

items.first_name

string | null

required

The candidate's first name.

items.last_name

string | null

required

The candidate's last name.

items.company

string | null

required

The name of the company where candidate has applied.

items.title

string | null

required

The position for which the candidate has applied

items.last_interaction_at

string | null

required

The date of the last interaction with the candidate.

items.is_private

boolean | null

required

Whether the candidate's information is private.

items.can_email

boolean | null

required

Whether the candidate can be emailed.

items.locations

string[] | null

required

The location of the candidate.

items.phone_numbers

string[] | null

required

The candidate's phone numbers.

items.email_addresses

string[] | null

required

The candidate's email addresses.

items.urls

object[] | null

required

The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.

items.tags

string[] | null

required

The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.

items.applications

string[] | null

required

The candidate's applications.

items.attachments

string[] | null

required

The candidate's attachments.

items.remote_created_at

string | null

required

When the third party's candidate was created.

items.remote_updated_at

string | null

required

When the third party's candidate was last updated.

items.avatar

string | null

required

The candidate's avatar.

items.raw_data

object | null

This is the Raw data

Get Attachment By Id Create Candidate

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "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"
      },
      "first_name": "John",
      "last_name": "Doe",
      "company": "Google",
      "title": "SOFTWARE ENGINEER",
      "last_interaction_at": "2021-07-01T00:00:00Z",
      "is_private": true,
      "can_email": true,
      "locations": [
        "San Francisco",
        "New York"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "email_addresses": [
        "john@doe.com"
      ],
      "urls": [
        {
          "type": "LINKEDIN",
          "value": "https://www.linkedin.com/in/johndoe"
        }
      ],
      "tags": [
        "JUNIOR",
        "INTERMEDIATE"
      ],
      "applications": [
        "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
      ],
      "attachments": [
        "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
      ],
      "remote_created_at": "2021-07-01T00:00:00Z",
      "remote_updated_at": "2021-07-01T00:00:00Z",
      "avatar": "https://www.example.com/avatar.jpg"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response