/candidates

Returns a collection of the job's candidates. Required scope: r_candidates. Accessible with all token types.

get/candidates

Request

Base URL
https://subdomain.workable.com/spi/v3
URL
https://subdomain.workable.com/spi/v3/candidates
Auth
API key in header Authorization

Query parameters

emailstring

The email of the candidate to filter by

shortcodestring

The job's system generated code

stagestring

The job's stage slug, can be retrieved from the /stages endpoint

limitinteger

Specifies the number of candidates to try and retrieve per page

since_idstring

Returns results with an ID greater than or equal to the specified ID.

max_idstring

Returns results with an ID less than or equal to the specified ID.

created_afterstring date-time

Returns results created after the specified timestamp.

updated_afterstring date-time

Returns results updated after the specified timestamp.

Response

200

Example response

{
  "candidates": [
    {
      "id": "ce4da98",
      "name": "Lakita Marrero",
      "firstname": "Lakita",
      "lastname": "Marrero",
      "headline": "Operations Manager",
      "account": {
        "subdomain": "groove-tech",
        "name": "Groove Tech"
      },
      "job": {
        "shortcode": "GROOV005",
        "title": "Office Manager"
      },
      "stage": "Interview",
      "disqualified": true,
      "profile_url": "https://groove-tech.workable.com/backend/jobs/376844767/candidates/216323526",
      "email": "lakita_marrero@gmail.com",
      "domain": "twitter.com",
      "created_at": "2015-06-26T00:00:00Z",
      "updated_at": "2015-07-08T14:46:48Z"
    }
  ],
  "paging": {
    "next": "https://www.workable.com/spi/v3/accounts/groove-tech/candidates?limit=3&since_id=2789d6dg"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.