RErecruitee

/candidates

Calling the /candidates endpoint will return a collection of the company's candidates. If limit and offset are not provided, all candidates will be returned.

This endpoint hits the database directly, so getting the response might take some time, depending on the number of candidates.

WARNING: For searching candidates it is advised to use /search/new/candidates endpoint for better performance.

get/c/{company_id}/candidates

Request

  • Base URL
    https://api.recruitee.com
  • URL
    https://api.recruitee.com/c/{company_id}/candidates
  • Auth
    OAuth 2

Path parameters

company_idinteger required

Company ID. A company subdomain can also be used.

Query parameters

limitinteger

Specifies the number of candidates to retrieve

offsetinteger

Skip number of candidates from the begining, used for ‘load more’, offset for next page should be current offset + limit

created_afterstring date-time

Show only candidates created after given date (yyyy-mm-ddThh:mm:ss) Letter 'T' separates the date and time. Also works without seconds.

disqualifiedboolean

Show only disqualified candidates who are disqualified in at least one job (should be string ‘true’ or ‘1’).

qualifiedboolean

Show only disqualified candidates who are qualified in at least one job (should be string ‘true’ or ‘1’).

idsstring

List of IDs separated by comma, example: 234221,4211412,535432

offer_idstring

Filter by offer

querystring

Search query for candidate’s name or offer

sortstring

Sorting options: by_date, by_last_message

with_messagesboolean

Show only candidates with messages (should be string ‘true’ or ‘1’)

with_my_messagesboolean

Show only candidates with messages that current admin sent (should be string ‘true’ or ‘1’)

Response

200

generated_atstring
limitinteger
offsetinteger

Example response

{
  "candidates": [
    {
      "adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=28057517&company=49498",
      "created_at": "2021-09-01T13:51:27.079963Z",
      "emails": [
        "jane@example.com"
      ],
      "id": 28057517,
      "name": "Jane Doe",
      "photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/28057517/thumb_photo_2cfp2hcnntv9.png",
      "placements": [
        {
          "candidate_id": 28057517,
          "created_at": "2021-09-01T13:51:30.243946Z",
          "id": 29327897,
          "language": {
            "code": "en",
            "name": "English",
            "native_name": "English"
          },
          "offer_id": 744511,
          "position": 8,
          "stage_id": 4190047,
          "updated_at": "2021-09-01T13:51:30.243946Z"
        }
      ],
      "source": "career_site",
      "updated_at": "2021-09-01T13:51:36.503025Z",
      "viewed": true
    }
  ],
  "generated_at": "2021-09-01T13:52:15.776625Z",
  "limit": 2,
  "offset": 100,
  "references": [
    {
      "id": 744511,
      "kind": "job",
      "lang_code": "en",
      "location": "Remote job",
      "position": 1,
      "slug": "example-offer",
      "status": "published",
      "title": "Example offer",
      "type": "Offer"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.