> For the complete documentation index, see [llms.txt](https://docs.getpurpledot.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getpurpledot.com/docs/purple-dot-apis/public-api.md).

# Public API

### [Overview](#webhooks) <a href="#webhooks" id="webhooks"></a>

This reference documents the public API that can be used to get information about Waitlists and product availability, both server- and client-side.

### [Authentication](#authentication) <a href="#authentication" id="authentication"></a>

Include your store's public API key as an `api_key` query parameter in all requests.

### [Versioning](#versioning) <a href="#versioning" id="versioning"></a>

The API is versioned using a URL prefix. The current version is `v1`, and all endpoints use the `/api/v1/` namespace.

### [Response Format](#response-format) <a href="#response-format" id="response-format"></a>

All responses follow a common format:

{% code overflow="wrap" %}

```json
{
  "meta": {
    "result": "success"
  },
  "data": /* Response data */
}
```

{% endcode %}

### [Endpoints](#endpoints) <a href="#endpoints" id="endpoints"></a>

[/waitlists](/docs/purple-dot-apis/public-api/waitlists.md)

[/availability](/docs/purple-dot-apis/public-api/availability.md)

[/products/preorder-state](/docs/purple-dot-apis/public-api/products-preorder-state.md)

[/variants/preorder-state](/docs/purple-dot-apis/public-api/variants-preorder-state.md)

[/pre-orders](/docs/purple-dot-apis/public-api/pre-orders.md)