{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/conversation","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/candidate/000000000000/conversation?include_delayed=1&skip=50"}]},"method":"get","results":{"codes":[{"language":"json","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]","name":"","status":200},{"code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token","status":400,"language":"json"},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"getConversationError\",\n        \"message\": \"there was an unknown error getting candidate conversation.\"\n    }\n}","language":"json","status":500}]},"settings":"","params":[{"name":"company_id","type":"string","default":"","desc":"company _id","required":true,"in":"path","ref":"","_id":"57a8b0043ec56d0e001ee3d9"},{"name":"position_id","type":"string","default":"","desc":"position id","required":true,"in":"path","ref":"","_id":"57a8b0043ec56d0e001ee3d8"},{"name":"candidate_id","type":"string","default":"","desc":"candidate id","required":true,"in":"path","ref":"","_id":"57a8b0043ec56d0e001ee3d7"},{"name":"include_delayed","type":"int","default":"0","desc":"1 or 0 to return any messages that are currently queued for delayed delivery","required":false,"in":"query","ref":"","_id":"5a679a6ca401bd0028f4c1fd"},{"name":"skip","type":"int","default":"0","desc":"Number of records to skip for paging","required":false,"in":"query","ref":"","_id":"5a679a6ca401bd0028f4c1fc"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/conversation","type":"endpoint","slug":"company-position-candidate-conversation","excerpt":"Retrieve candidate conversation stream","body":"","updates":[],"order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f64e792a330012d7214d","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":"2016-06-14T16:41:15.805Z","githubsync":"","__v":10,"updatedAt":"2019-07-05T13:06:39.180Z"}

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