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

    • Related Articles

    • How to print instructions

      Overview Your facility may employ staff that need a quick reference guide to use the software.  Create or print easy to use instructions to train your staff.   Here is how 1.  Find relevant articles by clicking the tag gate attendant or lifeguard. ...
    • How to check in patrons without a pass

      Overview Members who do not present a pool pass can still be checked in using PoolPass software.  Directions are slightly different with or without family check-in enabled.   Here is how - with family check-in enabled Click Member List Search their ...
    • How to check in patrons with a pass

      Overview Directions are slightly different with or without family check-in enabled.   Here is how (with family check-in enabled) 1. Scan in the pass 2. Check the patrons present 3. Click Check In Members If the patron is green, they may enter If the ...
    • How to log in

      Overview Here is how to log into Pool Pass & Access Granted Systems software.   Here is how 1.  Open the software at: https://accessgrantedsystems.com/  We recommend bookmarking this website.   2. Click Log In and enter your email and password.  ...
    • How to use the check-out feature

      Overview The occupancy feature is a tool for the gate attendants to keep track of the number of patrons in the pool area.  The check-out feature is used in conjunction with the occupancy feature to record specific patrons leaving the facility.  When ...
    • Popular Articles

    • ePasses - Instructions for Patrons

      Overview An ePass is a special file (.pkpass) you can store in a Wallet app on a mobile device. Display them to the attendant to gain access to your facility.  How do I get my ePasses? Your community will send them to you by email.  Check your Inbox ...
    • What is the recommended hardware?

      Overview Our clients use a variety of PCs, smart phones, tablets, 2D QR barcode scanners, operating systems, and web browsers to access our services. Hardware We recommend using a PC running Windows 11 to access our web portal via Microsoft Edge ...
    • How to sell a 5 punch guest pass

      Overview Patrons will purchase this ticket at the marketplace.  These are the recommended settings for communities that wish to sell a guest pass that can be used up to five times.  Five single use passes are issued but must be purchased in lots of ...
    • How Applications Work

      Overview   Patrons may request access to your facility by completing an application. Features Online Submissions Paper Submissions (if enabled) Custom Built Membership Types Collect Waivers Collect Unique Facility Information Collect Fees & Payments ...
    • How to upload your member list

      Overview Administrators can upload their patrons (members) into the PoolPass software in bulk.  Here is how Get your member list ready for upload. A properly formatted CSV (comma separated value) file is need to import members.  Most spreadsheet apps ...

    Need live help?