get https://{subdomain}.workable.com/spi/v3/candidates/
Returns specified candidate. Required scope: r_candidates. Accessible with all token types.
Response
Calling the candidates/:id will return the full job JSON object of a specific candidate
| key | type | description |
|---|---|---|
| id | string | The candidate identifier |
| name | string | The full name of the candidate |
| firstname | string | The first name of the candidate |
| lastname | string | The last name of the candidate |
| headline | string | The headline of the candidate |
| image_url | string | Url of candidate's avatar. Available only if provided by the candidate |
| account/subdomain | string | The subdomain of the account |
| account/name | string | The name of the account |
| job/shortcode | string | The shortcode of the job |
| job/title | string | The title of the job |
| stage | string | The name of the current stage. See stages endpoint |
| stage_kind | string | The kind of the current stage. See stages endpoint |
| disqualified | boolean | Indicates if the candidate is disqualified |
| withdrew | boolean | True if the candidate withdrew and was disqualified |
| disqualified_at | timestamp | The timestamp the candidate was disqualified |
| disqualification_reason | string | The reason the candidate was disqualified |
| sourced | boolean | Indicates if the candidate is sourced true or applied false |
| profile_url | string | Url to the candidate's profile |
| address | string | The address of the candidate |
| phone | string | The phone number of the candidate |
string | The email address of the candidate | |
| outbound_mailbox | string | Mailbox that can be used to communicate with the candidate and inform the recruitment team of the job as well |
| domain | string | The domain of the referrer site that linked to the job page or the job board the job advertised |
| uploader_id | string | The id of the member uploaded the candidate. |
| created_at | timestamp | The timestamp the candidate created |
| updated_at | timestamp | The timestamp the candidate last updated |
| cover_letter | string | The cover letter provided when candidate applied |
| summary | string | The summary of the candidate |
| education_entries | array | A collection with education entries |
| education_entries/degree | string | The graduation degree |
| education_entries/school | string | The name of the school graduated |
| education_entries/field_of_study | string | The field of study |
| education_entries/start_date | date | The date started |
| education_entries/end_date | date | The date ended |
| experience_entries | array | A collection with working experience entries |
| experience_entries/title | string | The title of the experience entry |
| experience_entries/summary | string | The summary of the experience entry |
| experience_entries/start_date | date | The date started |
| experience_entries/end_date | date | The date ended |
| experience_entries/company | string | The company name |
| experience_entries/industry | string | The industry of the company |
| experience_entries/current | boolean | Indicates if currently works there |
| skills | array | A collection with skill names |
| answers | array | A collection with the answers provided |
| resume_url | string | Url to the candidate resume |
| social_profiles | array | A collection with social profiles of the candidate |
| social_profiles/type | string | The slug name of the social profile. It can be one of the following types: academiaedu, angellist, behance, bitbucket, blogger, crunchbase, dandyid, delicious, deviantart, digg, doyoubuzz, dribble, dribbble, econsultancy, facebook, flavorsme, flickr, fullcontact, getglue, gist, github, goodreads, googleplus, gravatar, hackernews, hiim, klout, lanyrd, linkedin, myspace, ohloh, orkut, pinterest, quora, reddit, scribd, skype, slideshare, stackexchange, stackoverflow, tumblr, twitter, typepad, vk, wordpress, xing |
| social_profiles/name | string | The full name of the social profile |
| social_profiles/url | string | Url to the candidate's social profile page |
| tags | array | A collection with tags |
| hired_at | date | The date the candidate was moved to the hired stage |
| location | object | The location of the candidate |
| location/location_str | string | The string representation of the location |
| location/country | string | The country full name |
| location/country_code | string | The 2-letter ISO code of the country |
| location/region | string | The region of the candidate |
| location/region_code | string | The code of the region of the candidate |
| location/city | string | The city of the candidate |
| location/zip_code | string | The ZIP code of the candidate |
| originating_candidate_id | string | The ID this candidate originated from (has a value in case of candidate copy / move) |
