PeopleForce
Candidates

List candidates

GET
/api/public/v3/recruitment/candidates

Query Parameters

created_at[gte]?integer

Unix epoch seconds

created_at[lte]?integer

Unix epoch seconds

email?string
phone_numbers[]?array<string>
pipeline_stage_id?integer
skills[]?array<string>
updated_at[gte]?integer

Unix epoch seconds

updated_at[lte]?integer

Unix epoch seconds

vacancy_ids[]?array<integer>

Response Body

application/json

curl -X GET "https://example.com/api/public/v3/recruitment/candidates"
{  "data": [    {      "id": 0,      "full_name": "string",      "email": "string",      "cover_letter": "string",      "resume": true,      "created_by": {        "id": 0,        "first_name": "string",        "last_name": "string",        "email": "string"      },      "applications": [        {          "id": 0,          "disqualified_at": null,          "vacancy": {            "id": 0,            "title": "string"          },          "created_at": "string",          "updated_at": "string",          "pipeline_state": {            "id": 0,            "name": "string"          },          "disqualify_reason": null,          "insights": {            "status": "not_enabled",            "match": "no_match",            "justification": "string",            "must_haves": [              {                "criterion": "string",                "match": true,                "justification": "string"              }            ],            "nice_to_haves": [              {                "criterion": "string",                "match": true,                "justification": "string"              }            ],            "red_flags": [              {                "criterion": "string",                "match": true,                "justification": "string"              }            ]          }        }      ],      "created_at": "string",      "updated_at": "string",      "skills": [        "string"      ],      "desired_salary": 0,      "currency_code": "string"    }  ],  "metadata": {    "pagination": {      "page": 0,      "pages": 0,      "count": 0,      "items": 0    }  }}