List candidates

This endpoint lets you retrieve all candidates for a given job reference.

This endpoint requires candidates_r or my_candidates_r scope.

candidate list

GET https://www.welcomekit.co/api/v1/external/candidates

Query Parameters

Name	Type	Description
referrer	string	Filter by referrer
job_reference*	string	Job reference
email	string	Email
origin	string	Filter by origin
job_stage_id	string	Filter by job stage id
job_stage_reference	string	Filter by job stage reference
archived	string	Only returns archived candidates or not
created_after	string	Only returns candidates created after this date (YYYY-MM-DD)
updated_after	string	Only returns candidates updated after this date (YYYY-MM-DD)
per_page	integer	Number of jobs per page
page	integer	Page offset
stage	boolean	Returns related job stage (i.e. refused, hire, etc.)
tags	boolean	Returns related tags

200 Success

[
  {
    "reference": "wttj-d655345409a6097309156b05",
    "cover_letter": "",
    "created_at": "2016-08-23T12:55:27.206+02:00",
    "job_reference": "WTTJ_KmqkD1Y",
    "modal_path": "/dashboard/o/Pg4eV6k/jobs/WTTJ_KmqkD1Y/card/wttj-d655345409a6097309156b05",
    "portfolio_size": 4242,
    "portfolio_url": "http://cdn.com/porfolio.pdf",
    "resume_content_type": "application/pdf",
    "resume_size": 4242,
    "resume_url": "http://cdn.com/resume.pdf",
    "stage_id": 14600,
    "stage":{
      "id": 14600,
      "name":"Refusé",
      "reference":"refused",
      "visible":true
    },
    "updated_at": "2016-08-23T12:55:27.206+02:00",
    "profile": {
      "address": null,
      "avatar_url": "http://wk.dev/assets/default-avatar-7cbb7b9749a7cf8864001cde13e2a9a94e612bf083430d66ede0966f5bafb296.png",
      "city": null,
      "country_code": null,
      "country_name": null,
      "email": "[email protected]",
      "firstname": "Foo",
      "lastname": "Bar",
      "phone": null,
      "subtitle": null,
      "zip_code": null
    },
    "origin": "external",
    "archived": false
  },
  ...
]

Request example

curl -X GET -G "https://www.welcomekit.co/api/v1/external/candidates" \
    -d "job_reference=WTTJ_KmqkD1Y" \
    -d "stage=true" \
    -H "Authorization: Bearer WK_API_KEY"