v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/jobs/:shortcode/candidates

Creates a candidate at the specified job. Required scope: w_candidates. Accessible with all token types.

post/jobs/{shortcode}/candidates

Path parameters

shortcodestring required

The job's shortcode

Query parameters

stagestring

Depending on the value of the sourced flag, candidates are put into the sourced or applied stage. But you can set this if you want to create a candidate directly in another stage. Values can be retrieved from the jobs/:shortcode/stages endpoint

Request body

candidatestring json

The candidate data

sourcedboolean

Indication that a candidate is sourced (Uploaded) or not (Applied)

Response

201

statusstring

Example response

{
  "status": "created",
  "candidate": {
    "id": "3fc9a80f",
    "name": "Jj Botha",
    "headline": "Professional Administration Manager",
    "account": {
      "subdomain": "groove-tech",
      "name": "Groove Tech"
    },
    "job": {
      "shortcode": "GROOV005",
      "title": "Office Manager"
    },
    "stage": "Sourced",
    "sourced": true,
    "profile_url": "https://groove-tech.workable.com/backend/jobs/376844767/candidates/1070179133",
    "address": "25772 Gustave Shore, Iowa, USA",
    "phone": "1-859-557-6573",
    "email": "jj_botha@fakemail.com",
    "outbound_mailbox": "b-6adwdc@outbound.dev-workable.mailgun.org",
    "created_at": "2015-07-09T10:55:53Z",
    "updated_at": "2015-07-09T10:55:53Z",
    "cover_letter": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "summary": "A focussed, results-driven team player with many year experience in the field. Working my way up to management level, I have experience of every aspect of this role. I understand the challenges it brings, and have a proven track record of providing solutions.",
    "education_entries": [
      {
        "id": "3fcbeedf",
        "degree": "MBA",
        "school": "University of Pennsylvania",
        "start_date": "2008-03-01",
        "end_date": "2011-03-30"
      }
    ],
    "experience_entries": [
      {
        "id": "3fdbfd0d",
        "title": "Sales Director",
        "start_date": "2011-03-01",
        "end_date": "2014-03-30",
        "company": "Vox Mobile",
        "industry": "Telecommunications"
      }
    ],
    "skills": [
      {
        "name": "travel planning"
      }
    ],
    "answers": [
      {
        "question": {
          "body": "Explain one aspect of this role you believe you will excel at."
        },
        "answer": {
          "body": "<p>Planning</p>"
        }
      }
    ],
    "social_profiles": [
      {
        "type": "twitter",
        "username": "jj_botha",
        "url": "http://www.twitter.com/jj_botha"
      }
    ]
  }
}