{"_id":"575ffb199b1a9a220067c22e","parentDoc":null,"user":"54ee197f67e09c230091e707","category":{"_id":"575ffb199b1a9a220067c224","project":"54ee19c23749bf0d00c76515","version":"575ffb199b1a9a220067c21e","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T20:55:14.360Z","from_sync":false,"order":5,"slug":"candidate-endpoints","title":"Candidate Endpoints"},"project":"54ee19c23749bf0d00c76515","version":{"_id":"575ffb199b1a9a220067c21e","__v":1,"project":"54ee19c23749bf0d00c76515","createdAt":"2016-06-14T12:39:53.763Z","releaseDate":"2016-06-14T12:39:53.763Z","categories":["575ffb199b1a9a220067c21f","575ffb199b1a9a220067c220","575ffb199b1a9a220067c221","575ffb199b1a9a220067c222","575ffb199b1a9a220067c223","575ffb199b1a9a220067c224","575ffb199b1a9a220067c225"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":5,"editedParams2":true,"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T21:28:06.710Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n  \t\"_id\":\"12ce3ddda35\",\n     \"name\":\"David Stevens\",\n     \"email_address\":\"davidstevens:::at:::somemail.com\",\n     \"summary\":\"Experienced iOS developer with leadership, sales and customer relations skills. Extensive familiarity with all aspects of mobile app development. Equally adept at writing code or talking to clients. Comfortable delivering a pitch, writing a spec, hashing out details and speaking to a crowd.\",\n     \"work_history\":[\n        {\n           \"title\":\"Lead iOS Developer\",\n           \"company_name\":\"Acme Inc.\",\n           \"start_date\":{\n              \"month\":12,\n              \"year\":2012\n           },\n           \"is_current\":true\n        },\n        {\n           \"title\":\"Owner/Developer\",\n           \"company_name\":\"Pocket Dev\",\n           \"start_date\":{\n              \"month\":8,\n              \"year\":2009\n           },\n           \"end_date\":{\n              \"month\":12,\n              \"year\":2012\n           }\n        },\n        {\n           \"title\":\"Software Developer\",\n           \"company_name\":\"Malta, Inc.\",\n           \"start_date\":{\n              \"month\":8,\n              \"year\":2007\n           },\n           \"end_date\":{\n              \"month\":8,\n              \"year\":2009\n           }\n        },\n        {\n           \"title\":\"Solutions Architect\",\n           \"company_name\":\"Computer Systems Support\",\n           \"start_date\":{\n              \"month\":5,\n              \"year\":2005\n           },\n           \"end_date\":{\n              \"month\":8,\n              \"year\":2007\n           }\n        }\n     ],\n     \"education\":[\n        {\n           \"school_name\":\"MIT\",\n           \"degree\":\"BS, \",\n           \"field_of_study\":\"Computer Science\",\n           \"start_date\":{\n              \"month\":8,\n              \"year\":1999\n           }\n        }\n     ],\n\t}\n]","language":"json","status":200},{"name":"Missing Access Token","code":"{\n  \"error\": \"No access token found\"\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"57a8b2c11ec0f519003e612e","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"company_id"},{"_id":"57a8b2c11ec0f519003e612d","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"position_id"},{"_id":"5888a0c9165af631008ee30f","ref":"","in":"query","required":false,"desc":"Add this parameter to force paging of results","default":"","type":"int","name":"page_size"},{"_id":"5888a0c9165af631008ee30e","ref":"","in":"query","required":false,"desc":"If page size is passed, this determines which page of data will be returned","default":"1","type":"int","name":"page"},{"_id":"5888a0c9165af631008ee30d","ref":"","in":"query","required":false,"desc":"Determines the sort order of the data returned. Can be (created | updated)","default":"updated","type":"string","name":"sort"}],"url":"/v2/company/:company_id/position/:position_id/candidates"},"isReference":true,"order":16,"body":"","excerpt":"Retrieve all candidates for given position","slug":"companypositionidcandidates","type":"endpoint","title":"./candidates"}

get./candidates

Retrieve all candidates for given position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string

Query Params

page_size:
integer
Add this parameter to force paging of results
page:
integer1
If page size is passed, this determines which page of data will be returned
sort:
stringupdated
Determines the sort order of the data returned. Can be (created | updated)

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}