# Public API

_If you are using our_ [_Shopify App_](https://apps.shopify.com/purple-dot)_, this section is irrelevant and you should follow_ [installing-our-shopify-app](../shopify-app-integration/installing-our-shopify-app "mention") _instead. See_ [_Purple Dot Overview_](../purple-dot-overview) _for the comparison of our Shopify App vs. Platform integrations._

### [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](public-api/waitlists "mention")

[availability](public-api/availability "mention")

[products-preorder-state](public-api/products-preorder-state "mention")

[variants-preorder-state](public-api/variants-preorder-state "mention")

[pre-orders](public-api/pre-orders "mention")
