{"_id":"5a99986791a1190033a20528","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"},"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"},"user":"575f003663430e0e008a8704","githubsync":"","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-02T18:31:03.248Z","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://app.breezy.hr/public/api/v3/company/000000000000/candidates/search?email_address=this:::at:::that.com","language":"curl"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"[{\n  _id: String,\n  name: String,\n\tposition: { Position Object }\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"},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"searchCompanyCandidatesError\",\n        \"message\": \"there was an unknown error getting candidate.\"\n    }\n}","language":"json","status":500},{"code":"{\n    \"error\": {\n        \"type\": \"searchCompanyCandidatesMissingEmail\",\n        \"message\": \"email_address is null or empty\"\n    }\n}","language":"json","status":400}]},"method":"get","auth":"required","params":[{"_id":"57a8afcd1ec0f519003e6127","ref":"","in":"path","required":true,"desc":"company id","default":"","type":"string","name":"company_id"},{"_id":"5a99986791a1190033a20529","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"email_address"}],"url":"/v:version/company/:company_id/candidates/search"},"isReference":true,"order":22,"body":"","excerpt":"Retrieve all candidates with entered email address","slug":"company-candidates-search","type":"endpoint","title":"./candidates/search"}

get./candidates/search

Retrieve all candidates with entered email address

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
company id

Query Params

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