Skip to main content
POST
/
api
/
ats
/
v1
/
candidates
Create Candidate
curl --request POST \
  --url https://api.bindbee.dev/api/ats/v1/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '
{
  "data": {
    "first_name": "John",
    "last_name": "Doe",
    "company": "Google",
    "title": "SOFTWARE ENGINEER",
    "is_private": true,
    "can_email": true,
    "locations": [
      "San Francisco",
      "New York"
    ],
    "phone_numbers": [
      "123-456-7890"
    ],
    "email_addresses": [
      "[email protected]"
    ],
    "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"
    ],
    "avatar": "https://www.example.com/avatar.jpg",
    "job_interview_stage_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
    "job_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
  },
  "remote_user_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "job_requisition_id": "R-00007"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
To create an candidate in ATS, you first need to fetch the request body structure that ATS expects. This structure varies based on the ATS provider (e.g., Greenhouse, Teamtailor, BambooHR). The request body consists of three parts:
  • Model Keys: Standard attributes required for all candidate.
  • Additional Attributes: Specific fields required by the chosen ATS.
  • Custom Fields: Extra metadata for specific implementations.
Note: Some attributes may have allowed_values, meaning only specific values are permitted based on the customer’s ATS configuration. Ensure you check for these constraints before submitting the request.

​
Step 1: Fetch the Required Request Body

Before calling the Create Candidate API, you need to get the request structure using the Meta Create Candidate API.

​
Step 2: Create an Candidate

Once you have the request body structure, use the Create Candidate API to send the request.

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

Body

application/json
​
data
PostCandidate · object
required
​
remote_user_id
string

The remote user's id

Example:

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

​
job_requisition_id
string

The job requisition id in external ATS

Example:

"R-00007"

Response

Successful Response