Most merchants never need this. Everything PocketPass does day to day happens automatically from your tee sheet, and the dashboard covers the rest. The API is for the cases where you want your own systems to read or change the same data — a membership site, an internal tool, or a piece of automation nobody else offers.
If that isn't you, you can safely skip this whole section.
What you can do with it
| Area | What the API gives you |
|---|---|
| Customers | List and search your golfers, read one, and update their details |
| Wallet passes | List passes and read one, including whether it's been added to a phone |
| House accounts | Read a golfer's balance and their transaction history |
Everything is scoped to your own merchant. A key only ever sees your data.
Where to find the reference
The full, interactive reference — every endpoint, every field, with example requests you can run — lives at pocketpass.golf/developers.
The same thing is available as a raw OpenAPI document at /api/v1/openapi.json if you'd rather import it into Postman, Insomnia, or a code generator.
The reference is generated from the API itself, so it can't drift out of date. When you want the exact shape of a response, trust the reference over any example in these articles.
The basics
- Base URL:
https://pocketpass.golf/api/v1 - Format: JSON in, JSON out
- Authentication: a bearer token on every request — see API keys and authentication
A request looks like this:
GET https://pocketpass.golf/api/v1/customers with the header Authorization: Bearer gp_live_…
Getting notified instead of polling
If you want to know when something changes, don't poll the API on a timer. PocketPass can POST to a URL of yours the moment a golfer is created, updated or deleted, when a pass is added to a phone, or when a house-account transaction is posted. See Webhooks.
Getting help
If something in the API doesn't behave the way the reference says, that's worth telling us about. Use the Talk to a person button in the help panel and include the endpoint, what you sent, and what came back.