Displaying an Occupancy Counter with the API

Capitan's API enables you to display your facility's currency occupancy in a way that's aligned with your website's colors and designs.

Before you start: create an API Integration user and copy its token, as described in Setting Up an API Integration and Obtaining a Token. The Check-In Stats endpoint needs no permissions ticked, so leave every checkbox unchecked. Capitan's API documentation describes how to make requests to the API.

To obtain your facility's current occupancy, make a GET request to the Check-In Stats API endpoint. The currently_checked_in_count  field indicates the current number of active check-ins. Note that this data will only be accurate if you require customers to check out upon leaving.

If your organization operates multiple facilities, you may pass in a location_id  GET parameter to obtain the Check-In Stats for an individual location.

Still need help? Contact Us Contact Us