BIbindbee
Candidate

Get Candidate By Id

Changed on

Returns a Candidate object with the given id.

get/api/ats/v1/candidates/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

first_namestring nullable

The candidate's first name.

last_namestring nullable

The candidate's last name.

companystring nullable

The name of the company where candidate has applied.

titlestring nullable

The position for which the candidate has applied

last_interaction_atstring nullable

The date of the last interaction with the candidate.

is_privateboolean nullable

Whether the candidate's information is private.

can_emailboolean nullable

Whether the candidate can be emailed.

locationsstring[] nullable

The location of the candidate.

phone_numbersstring[] nullable

The candidate's phone numbers.

email_addressesstring[] nullable

The candidate's email addresses.

tagsstring[] nullable

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

remote_created_atstring nullable

When the third party's candidate was created.

remote_updated_atstring nullable

When the third party's candidate was last updated.

avatarstring nullable

The candidate's avatar.

Example response

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

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the /// response property for the response status

    • info

      removed the BLOG enum value from the /// response property for the response status

    • info

      removed the COMPANY enum value from the /// response property for the response status

    • info

      removed the JOB_POSTING enum value from the /// response property for the response status

    • info

      removed the OTHER enum value from the /// response property for the response status

    • info

      removed the PERSONAL enum value from the /// response property for the response status

    • info

      removed the PORTFOLIO enum value from the /// response property for the response status

    • info

      removed the SOCIAL_MEDIA enum value from the /// response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API