# Private API

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

This reference documents the private API that can be used to access private data in Purple Dot.

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

Include your Purple Dot store's private access token as `X-Purple-Dot-Access-Token` header 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 `/admin/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": {
    "success": true
  },
  "data": /* Response data */
}
```

{% endcode %}

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

[waitlists](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/waitlists "mention")

[pre-orders](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/pre-orders "mention")

[pre-orders-count](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/pre-orders-count "mention")

[pre-orders-count-units-sku-sku](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/pre-orders-count-units-sku-sku "mention")

[inventory](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/inventory "mention")

[fulfillment-orders](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/fulfillment-orders "mention")

[fulfillment-orders-id-uuid](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/fulfillment-orders-id-uuid "mention")

[fulfillment](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/fulfillment "mention")

[refund](https://docs.getpurpledot.com/docs/purple-dot-apis/private-api/refund "mention")

####
