{"_id":"5a60f64e792a330012d7214a","category":{"_id":"5a60f64d792a330012d72141","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T23:49:16.381Z","from_sync":false,"order":0,"slug":"overview","title":"Overview"},"user":"54ee197f67e09c230091e707","parentDoc":null,"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"},"githubsync":"","__v":0,"updates":["59ba6d4d8168a90032cbcc50"],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T23:50:04.420Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Welcome to the Breezy API.\n\nThe Breezy API allows you to go beyond the features we provide out of the box and build something better suited for your needs.\n\nThis documentation and API are a work in progress and aim to provide a subset of the functionality used by the Breezy HR website.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"All API endpoints are rooted in **https://breezy.hr/public/api/v3** (this by itself is not a valid endpoint)\"\n}\n[/block]\nQuestions, problems and feedback should be sent to [support:::at:::breezyhr.com](mailto:support@breezyhr.com).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"If you are interested in web-hook availability, please email [support@breezyhr.com](mailto:support@breezyhr.com) to tell us what you're looking for.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"For older customers - If you are looking for v2 API documentation, it can be found here **http://developer.breezy.hr/v2.0**\"\n}\n[/block]","excerpt":"","slug":"overview","type":"basic","title":"Welcome"}
Welcome to the Breezy API. The Breezy API allows you to go beyond the features we provide out of the box and build something better suited for your needs. This documentation and API are a work in progress and aim to provide a subset of the functionality used by the Breezy HR website. [block:callout] { "type": "info", "body": "All API endpoints are rooted in **https://breezy.hr/public/api/v3** (this by itself is not a valid endpoint)" } [/block] Questions, problems and feedback should be sent to [support@breezyhr.com](mailto:support@breezyhr.com). [block:callout] { "type": "success", "body": "If you are interested in web-hook availability, please email [support@breezyhr.com](mailto:support@breezyhr.com) to tell us what you're looking for." } [/block] [block:callout] { "type": "warning", "body": "For older customers - If you are looking for v2 API documentation, it can be found here **http://developer.breezy.hr/v2.0**" } [/block]