{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id","auth":"required","examples":{"codes":[{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://api.breezy.hr/v3/company/000000000000","language":"curl"}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{ \n  Company Object\n}"},{"code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json","status":400,"name":"Missing Access Token"},{"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\": \"getCompanyError\",\n        \"message\": \"there was an unknown error getting company.\"\n    }\n}"}]},"settings":"","params":[{"name":"company_id","type":"string","default":"","desc":"company id","required":true,"in":"path","ref":"","_id":"57a8a953b1641a1700ede463"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"/company/:id/","type":"endpoint","slug":"company","excerpt":"Retrieve the company information associated with authenticated user and company id","body":"","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f651792a330012d72160","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Company Endpoints","slug":"company-endpoints","order":4,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72144","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:54:58.144Z","__v":0},"user":"575f003663430e0e008a8704","project":"54ee19c23749bf0d00c76515","parentDoc":null,"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":"2015-02-25T20:57:03.297Z","githubsync":"","__v":8,"updatedAt":"2019-07-05T13:03:35.063Z"}

get/company/:id/

Retrieve the company information associated with authenticated user and company id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
company id

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