{"_id":"5a60f652792a330012d7216b","category":{"_id":"5a60f64d792a330012d72145","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T20:55:04.025Z","from_sync":false,"order":5,"slug":"position-endpoints","title":"Position Endpoints"},"parentDoc":null,"project":"54ee19c23749bf0d00c76515","user":"54ee197f67e09c230091e707","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":4,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T21:20:22.251Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n\t{ Position Object },\n  ...\n]","name":""},{"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"getPositionsError\",\n        \"message\": \"there was an unknown error getting positions.\"\n    }\n}","language":"json","status":500}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://breezy.hr/public/api/v3/company/000000000000/positions?state=published"}]},"method":"get","auth":"required","params":[{"_id":"54ee3c9667e09c230091e7c6","ref":"","in":"query","required":false,"desc":"Specify an optional position state filter. e.g. draft, archived, published, closed, pending","default":"published","type":"string","name":"state"},{"_id":"57a8af002ad1150e009daaff","ref":"","in":"path","required":true,"desc":"company id","default":"","type":"string","name":"company_id"}],"url":"/v:version/company/:company_id/positions"},"isReference":true,"order":5,"body":"","excerpt":"Retrieve all positions for given company in given state (status)","slug":"company-positions","type":"get","title":"./positions"}

get./positions

Retrieve all positions for given company in given state (status)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
company id

Query Params

state:
stringpublished
Specify an optional position state filter. e.g. draft, archived, published, closed, pending

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