API Quick Start

Start here. Learn about environments, authentication, base URLs, and how to make your first request.

Overview

If you want to use APIs, ask the Customer Success (CS) team to create an API key. The CS team will ask what the key is for, and it's important to share this information since the APIs are connected to your Club's production environment. Meaning, if the API key is pinging the environment frequently, it can slow down the Customer's experience on your App.

Cost by Tier

Depending on the Club's Tier, API keys can be created and provided to Club Owners/GMs:

• Basic(+) tiers — $100/month to generate one or many API keys
• Pro or Autonomous(+) tier — free to generate API keys

What This API is For

Use the PodPlay API to integrate your systems with PodPlay.

Common use cases include:

• Creating community events and programming
• Retrieving customer activity and related data
• Synchronizing information between PodPlay and external systems

Environments

Most endpoints are available in both production and staging environments. Switch environments by changing the host.

Production

https://<your-site>.podplay.app

Staging

https://sandbox1.podplay.app

Base Path and Versioning

All v2 endpoints are available under:

/apis/v2/

Example endpoint:

GET /apis/v2/users/current/payment-method

Authentication

Authenticate requests using an API key via the x-api-key header:

x-api-key: <api_key>

Treat API keys like passwords: Do not commit them to source control

Quick Test Request

Option 1: Using curl

You can test your API key from the command line:

curl

curl -sS \
  -H "x-api-key: $PODPLAY_API_KEY" \
  https://<your-site>.podplay.app/apis/v2/users/current

Option 2: Using a Low-Code or Automation Platform

If you are using a low-code or automation tool (e.g., Zapier, Make, Retool, Postman, etc.), configure:

Method: GET

URL:

https://<your-site>.podplay.app/apis/v2/users/current

Header:

x-api-key: <your_api_key>

Conventions

• Responses are returned in JSON format.
• Standard HTTP status codes indicate success or errors.
• Use GET for retrieving data.
• Use POST, PATCH, or DELETE for modifying data.

Limits

For API-key integrations, the default rate limit is 300 requests per 60 seconds per Client IP. This applies to standard integration endpoints. Integrators should handle 429 Too Many Requests responses with retry/backoff and avoid large concurrent bursts.