> 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/private-api.md).

# 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](/docs/purple-dot-apis/private-api/waitlists.md)

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

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

[/pre-orders/count-units/sku/:sku](/docs/purple-dot-apis/private-api/pre-orders-count-units-sku-sku.md)

[/inventory](/docs/purple-dot-apis/private-api/inventory.md)

[/fulfillment-orders](/docs/purple-dot-apis/private-api/fulfillment-orders.md)

[/fulfillment-orders/:id(uuid)](/docs/purple-dot-apis/private-api/fulfillment-orders-id-uuid.md)

[/fulfillment](/docs/purple-dot-apis/private-api/fulfillment.md)

[/refund](/docs/purple-dot-apis/private-api/refund.md)

####