API Endpoint Documentation

Published January 24th, 2025 by Shawn Price

The Healthy Roster API documentation can be accessed via a swagger interface at https://public-api.healthyroster.com/swagger/ui/index The V1 of the API has been deprecated and will soon be removed from the documentation. To browse the correct version of the application, make sure to change the version to V2 and click explore in the site header: It i

Authentication

Published January 24th, 2025 by Shawn Price

Authentication for the Healthy Roster API uses a simple application id and application secret key pair passed as header values on each request. This can be seen in the swagger documentation below.   The two values are provided by Healthy Roster when an integration project is initiated. If a Sandbox environment is provided then the credentials will b

Leveraging the API for reporting integrations

Published January 24th, 2025 by Shawn Price

Reporting A common use-case for API integrations is to extract data for use in external reporting tools such as Tableau, Power BI or other third party solutions. While it's certainly possible to pull data from a myriad of endpoints available via the API, there are a handful of endpoints designed specifically for this task that simplify the work invo