{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidates","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidates?page_size=10&page=1&sort=created"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"_id\": String,\n    \"meta_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]","name":""},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token"},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}"},{"status":500,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"getCandidatesError\",\n        \"message\": \"there was an unknown error getting candidates.\"\n    }\n}"}]},"settings":"","params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2c11ec0f519003e612e"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2c11ec0f519003e612d"},{"name":"page_size","type":"int","default":"","desc":"Add this parameter to force paging of results (max: 50)","required":false,"in":"query","ref":"","_id":"5888a0c9165af631008ee30f"},{"name":"page","type":"int","default":"1","desc":"If page size is passed, this determines which page of data will be returned","required":false,"in":"query","ref":"","_id":"5888a0c9165af631008ee30e"},{"name":"sort","type":"string","default":"updated","desc":"Determines the sort order of the data returned. Can be (created | updated)","required":false,"in":"query","ref":"","_id":"5888a0c9165af631008ee30d"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidates","type":"endpoint","slug":"company-position-candidates","excerpt":"Retrieve candidates for given position with an abbreviated candidate object","body":"","updates":[],"order":21,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f64e792a330012d7215c","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Candidate Endpoints","slug":"candidate-endpoints","order":6,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:55:14.360Z","__v":0},"parentDoc":null,"user":"575f003663430e0e008a8704","project":"54ee19c23749bf0d00c76515","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568","5d1f4985a718ba002bfa4a52","5d1f53e3d10632001825a1f3"],"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","__v":4},"createdAt":"2015-02-25T21:28:06.710Z","githubsync":"","__v":15,"updatedAt":"2019-07-05T13:07:28.624Z"}

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