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


---

# Agent Instructions: 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:

```
GET https://docs.getpurpledot.com/docs/purple-dot-apis/public-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.