List candidate emails

This endpoint allows you retrieve all emails for a given candidate reference.

This endpoint requires emails_r, and candidates_r or my_candidates_r scopes.

list candidate emails

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

Query Parameters

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

200 Success

[
  {
    "id": 12345,
    "subject": "Greetings",
    "body": "Email body",
    "from_email": "[email protected]",
    "to": "[email protected]",
    "created_at": "2018-01-03T16:17:07.501+01:00",
    "origin": "api",
    "candidate_reference": "wttj-d655345409a6097309156b05",
    "attachments": []
  },
  ...
]

Request example

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