Docs
Search
K

Private Admin API

Overview

This reference documents the private Admin API that can be used to access private data in Purple Dot.
Include your store's private access token as X-Purple-Dot-Access-Token header in all requests.
The API is versioned using a URL prefix. The current version is v1, and all endpoints use the /admin/api/v1/ namespace.
All responses follow a common format:
{
"meta": {
"success": true
},
"data": /* Response data */
}

Endpoints