> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/readme.md).

# API Quick Start

### 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](https://docs.podplay.app/owners-playbook/the-podplay-system/overview-of-tiers), 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

{% hint style="info" %}
Most endpoints are available in both production and staging environments. Switch environments by changing the host.
{% endhint %}

**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>
```

{% hint style="warning" %}
Treat API keys like passwords: Do not commit them to source control
{% endhint %}

### Quick Test Request

#### Option 1: Using curl

You can test your API key from the command line:

{% code title="curl" %}

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

{% endcode %}

#### 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.