Cooper

Candidate Sync API

Staging Env

https://ats-api-staging.cooperhire.io

POST

/v1/candidates

candidate

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params multipart/form-data

candidate[first_name]

string

required

First name of candidate

Example:

John

candidate[last_name]

string

required

Last name of candidate

Example:

Doe

candidate[email]

string

required

Email for candidate

Example:

john@example.com

candidate[phone_no]

string

optional

Phone no of candidate

Example:

9876543210

candidate[linkedin_url]

string

optional

Linkedin url of candidate

Example:

https://linkedin.com/profile

candidate[documents][]

file

optional

Documents of candidate

Example:

cmMtdXBsb2FkLTE3MTc1ODEyODY2ODAtMg==/Lorem_ipsum.pdf

candidate[job_code]

string

required

Job Code

Example:

ea8srVzExiUo2lHlxTK1b20t2RdKXdKwBPoSvaSn+Cw=

candidate[utm_source]

enum<string> <char>

optional

UTM Source

Allowed values:

indeedinternalother

Example:

indeed

candidate[resume]

file

optional

Resume of candidate

Example:

cmMtdXBsb2FkLTE3NDQxMTQ5OTEyNDgtMw==/Lorem_ipsum.pdf

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ats-api-staging.cooperhire.io/v1/candidates' \
--form 'candidate[first_name]="John"' \
--form 'candidate[last_name]="Doe"' \
--form 'candidate[email]="john@example.com"' \
--form 'candidate[phone_no]="9876543210"' \
--form 'candidate[linkedin_url]="https://linkedin.com/profile"' \
--form 'candidate[documents][]=@"cmMtdXBsb2FkLTE3MTc1ODEyODY2ODAtMg==/Lorem_ipsum.pdf"' \
--form 'candidate[job_code]="ea8srVzExiUo2lHlxTK1b20t2RdKXdKwBPoSvaSn+Cw="' \
--form 'candidate[utm_source]="indeed"' \
--form 'candidate[resume]=@"cmMtdXBsb2FkLTE3NDQxMTQ5OTEyNDgtMw==/Lorem_ipsum.pdf"'

Responses

🟢200OK

application/json

Body

candidate

object

required

Example

{
    "candidate": {
        "id": "2a83120e-0290-4363-a8c6-80880010e6fd",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com",
        "linkedin_url": "https://example.com",
        "stage": "new",
        "phone_no": "9876543210",
        "job_id": 1201,
        "documents": [],
        "resume": {
            "url": "https://example.com/directory/b58bb6c6-075e-44a5-b560-806d3f26f018_resume.pdf"
        },
        "utm_source": "other",
        "created_at": "2024-06-05T10:18:04.087Z",
        "average_rating": 0,
        "recruiter": {
            "id": 1,
            "first_name": "Company",
            "last_name": "A",
            "logo": {
                "url": null
            }
        },
        "job": {
            "id": 1201,
            "title": "Senior Data Science Analyst",
            "country": "Germany",
            "city": "Berlin",
            "deleted": false
        }
    }
}

Candidates