List candidate documents

This endpoint lets you retrieve all attached documents for a given candidate_reference.

This endpoint requires documents_r, and candidates_r or my_candidates_r scopes.

candidate documents

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

Query Parameters

Name	Type	Description
candidate_reference*	string	Candidate reference
per_page	integer	Number of documents per page
page	integer	Page offset

200 Success

[
  {
    "id": 20,
    "job_reference": "WTTJ_KmqkD1Y",
    "candidate_reference": "wttj-d655345409a6097309156b05",
    "filename": "example",
    "file_url": "http://example.com/example.pdf",
    "size": 433994,
    "content_type": "application/pdf",
    "created_at": "2018-01-08T11:46:02.990+01:00"
  },
  ...
]

Request example

curl -X GET -G "https://www.welcomekit.co/api/v1/external/documents" \
    -d "candidate_reference=wttj-d655345409a6097309156b05" \
    -H "Authorization: Bearer WK_API_KEY"