API Documentation

API Documentation

Overview

The PoolPass cloud service Application Programmer Interface provides a mechanism by which you can integrate our service into your own app, web server, or other software component. We expose various well-defined RESTful service endpoints to which you make requests to over the internet via HTTP methods. As an example, you could:
  1. Suspend/Reinstate a membership
  2. Add/Delete a member
  3. Update an expiration date
  4. Check-in a member
  5. Request your facility's occupancy and display it on your community's website.  
  6. More...

The API documentation describes how to use our API and is intended for software developers with a background in web development. We assume prior knowledge of the HTTP protocol, HTTP headers, and JSON format. This manual provides examples in various programming languages, but you can use any language you wish.

API Documentation is divided into two parts. The API Manual provides the details on how to use the API service. The API Reference describes each REST method along with the required parameters and the generated responses. The API Reference is available interactively and allows you to try the methods directly from the web page. You can also download a .pdf file of the API reference.


Interactive API Reference


Download API Reference as a PDF