Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Candidate

Get Candidates

Returns a list of Candidate objects.

get/api/ats/v1/candidates

Query parameters

idsstring nullable

The ID of the candidates to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the candidates to fetch

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

companystring nullable

If provided, will only return candidate for these companies

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

If provided, will only return candidate for these companies

first_namestring

If provided, will return candidates with this first name

Example:John

If provided, will return candidates with this first name

last_namestring

If provided, will return candidates with this last name

Example:Kremlin

If provided, will return candidates with this last name

tagstring

If provided, will return candidates with this tag

Example:Tech Experience

If provided, will return candidates with this tag

email_addressesstring[]

If provided, will return candidates with these email addresses

If provided, will return candidates with these email addresses

include_raw_databoolean

Include raw data in the response

Include raw data in the response

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

page_sizeinteger

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

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

cursorstring

The pagination cursor value.

The pagination cursor value.

expandstring

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]

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.

modified_afterstring

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

Example:2024-02-21T21:22:12.993Z

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

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "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,
      "remote_created_at": "2021-07-01T00:00:00Z",
      "remote_updated_at": "2021-07-01T00:00:00Z",
      "avatar": "https://www.example.com/avatar.jpg"
    }
  ]
}