Welcome to the Jungle Solutions API
  • Introduction
  • 🔓Authentication
  • 🔭Scopes
  • 🏷️Errors and Status
  • Jobs API
    • Jobs
      • Jobs dependencies
        • Languages
        • List available professions
      • List all jobs
      • List organization's jobs
      • Retrieve a job
      • Create a job
      • Update a job
      • Update a job status
    • Departments
      • List departments
      • Create a department
      • Update a department
      • Retrieve a department
    • Offices
      • List offices
      • Create an office
      • Update an office
      • Retrieve an office
  • Candidates API
    • Candidates
      • List candidates
      • Retrieve a candidate
      • Create a candidate
      • Update a candidate
    • Comment
    • Emails
      • List candidate emails
      • Create an email
    • Documents
      • List candidate documents
      • Attach documents to a candidate
    • Current user
  • Employer branding API
    • Organizations
      • Retrieve Organization's info
      • List organizations
    • Images
    • videos
    • Embed
    • Tools
    • Sectors
  • Analytics API
    • Moves
  • Media API
    • WTTJ articles
  • ⁉️FAQ
Powered by GitBook
On this page

Was this helpful?

  1. Candidates API
  2. Emails

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

[
  {
    "id": 12345,
    "subject": "Greetings",
    "body": "Email body",
    "from_email": "test@example.com",
    "to": "example@test.com",
    "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"
PreviousEmailsNextCreate an email

Last updated 3 years ago

Was this helpful?