{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/documents","auth":"required","settings":"","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/candidate/000000000000/documents"}]},"method":"get","results":{"codes":[{"code":"[\n\t{\n\t\t\"_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,        \n\t\t\"candidate_id\": String,\n\t\t\"acting_user\": { User | Candidate},\n\t\t\"file_name\": String,\n\t\t\"file_url\": String,\n\t\t\"file_size\": Integer,\n\t\t\"creation_date\": Date\n\t},\n  ...\n]","language":"json","status":200,"name":""},{"status":400,"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json"},{"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\": \"getDocumentsError\",\n        \"message\": \"there was an unknown error getting documents.\"\n    }\n}"}]},"params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b16e7eb4500e00fddf1c"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b16e7eb4500e00fddf1b"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b16e7eb4500e00fddf1a"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/documents","type":"endpoint","slug":"company-position-candidate-documents","excerpt":"Retrieve candidate documents by id for given position","body":"","updates":[],"order":7,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f64e792a330012d7214f","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},"user":"575f003663430e0e008a8704","parentDoc":null,"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":"2016-06-14T15:46:49.122Z","githubsync":"","__v":8,"updatedAt":"2019-07-05T13:06:46.768Z"}

get./candidate/:id/documents

Retrieve candidate documents by id for given position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string
candidate_id:
required
string

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