{"_id":"5a60f64e792a330012d7214d","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":"575f003663430e0e008a8704","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"},"__v":7,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-14T16:41:15.805Z","link_external":false,"link_url":"","githubsync":"","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/candidate/000000000000/conversation?include_delayed=1&skip=50","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"[\n  {\n    \"_id\": String,\n    \"type\": \"messageToCandidatePosted | messageFromCandidatePosted\",\n    \"object\": {\n      \"body\": String,\n      \"subject\": Subject,\n      \"attachments\": [\n        {\n      \t\t\"status\": String,\n        \t\"file_name\": String,\n        \t\"url\": String,\n        \t\"content_type\": String\n        },\n        ...\n      ],      \n      \"candidate_id\": String,\n      \"company_id\": String,\n      \"position_id\": String,\n      \"acting_user\": { Candidate | User}\n    },\n    \"timestamp\": Date\n  }\n]","language":"json"},{"language":"json","status":400,"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}"},{"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\": \"getConversationError\",\n        \"message\": \"there was an unknown error getting candidate conversation.\"\n    }\n}"}]},"settings":"","auth":"required","params":[{"_id":"57a8b0043ec56d0e001ee3d9","ref":"","in":"path","required":true,"desc":"company _id","default":"","type":"string","name":"company_id"},{"_id":"57a8b0043ec56d0e001ee3d8","ref":"","in":"path","required":true,"desc":"position id","default":"","type":"string","name":"position_id"},{"_id":"57a8b0043ec56d0e001ee3d7","ref":"","in":"path","required":true,"desc":"candidate id","default":"","type":"string","name":"candidate_id"},{"_id":"5a679a6ca401bd0028f4c1fd","ref":"","in":"query","required":false,"desc":"1 or 0 to return any messages that are currently queued for delayed delivery","default":"0","type":"int","name":"include_delayed"},{"_id":"5a679a6ca401bd0028f4c1fc","ref":"","in":"query","required":false,"desc":"Number of records to skip for paging","default":"0","type":"int","name":"skip"}],"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/conversation"},"isReference":true,"order":1,"body":"","excerpt":"Retrieve candidate conversation stream","slug":"company-position-candidate-conversation","type":"endpoint","title":"./candidate/:id/conversation"}

get./candidate/:id/conversation

Retrieve candidate conversation stream

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
company _id
position_id:
required
string
position id
candidate_id:
required
string
candidate id

Query Params

include_delayed:
integer0
1 or 0 to return any messages that are currently queued for delayed delivery
skip:
integer0
Number of records to skip for paging

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