{"_id":"5a60f64e792a330012d7215c","category":{"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T20:55:14.360Z","from_sync":false,"order":6,"slug":"candidate-endpoints","title":"Candidate Endpoints"},"parentDoc":null,"user":"54ee197f67e09c230091e707","project":"54ee19c23749bf0d00c76515","version":{"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":2,"createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"githubsync":"","__v":11,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T21:28:06.710Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidates?page_size=10&page=1&sort=created","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"_id\": String,\n    \"creation_date\": Date,\n    \"email_address\": String,\n    \"headline\": String,\n    \"initial\": Char(1),\n    \"name\": String,\n    \"origin\": \"applied | sourced | recruiter | referral\",\n    \"phone_number\": String,\n    \"profile_photo_url\": String,\n    \"resume\": {\n      \"file_name\": String,\n      \"url\": String,\n      \"pdf_url\": String\n\t\t},\n    \"source\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": String\n    },\n    \"stage\": {\n      \"id\": String,\n      \"name\": String,\n      \"type\": {\n        \"id\": String,\n        \"name\": String,\n        \"icon\": String\n      }\n    },\n    \"tags\": [String,...],\n    \"updated_date\": Date\n\t},\n\t...\n]","language":"json","status":200},{"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"getCandidatesError\",\n        \"message\": \"there was an unknown error getting candidates.\"\n    }\n}","language":"json","status":500}]},"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 (max: 50)","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":"/v:version/company/:company_id/position/:position_id/candidates"},"isReference":true,"order":17,"body":"","excerpt":"Retrieve candidates for given position with an abbreviated candidate object","slug":"company-position-candidates","type":"endpoint","title":"./candidates"}

get./candidates

Retrieve candidates for given position with an abbreviated candidate object

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 (max: 50)
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)

Examples


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 }}