Skip to content
Stashtab Vault API
Esc
↑↓navigate↵open⌘Jpreview

List products

GET/products
Authorization
X-API-KeyAPI key · headerrequired
API key in format `sk_*`. Scoped to your partner account; server-side use only.
Query parameters
pageinteger
Page number (1-based).
min 1 · default: 1
page_sizeinteger
Items per page.
min 1 · max 250 · default: 25
skustring
Filter by SKU.
Responses
200Paginated products.
page_sizeintegerrequired
Requested page size.
countintegerrequired
Items in this page.
totalintegerrequired
Total items across all pages.
current_page_numberintegerrequired
next_page_numberinteger | null
nextstring<uri> | null
URL of the next page.
previousstring<uri> | null
previous_page_numberinteger | null
resultsProduct[]required
Show properties
Array of Product
dimensionsDimensionsrequired
Show properties
heightnumberrequired
lengthnumberrequired
unitstringrequired
Allowed:incm
widthnumberrequired
image_urlstring<uri> | null
namestringrequired
skustringrequired
Unique within the partner organization.
upcstring | null
weightWeightrequired
Show properties
unitstringrequired
Allowed:ozg
valuenumberrequired
created_atstring<date-time>required
product_idstring<uuid>required
updated_atstring<date-time>required
400Validation failed.
codeErrorCoderequired
Stable machine-readable error vocabulary for v1.
Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited
extraobjectrequired
Structured details such as field errors or SKU availability.
messagestringrequired
Human-readable summary.
401Missing, invalid, expired, or environment-mismatched API key.
codeErrorCoderequired
Stable machine-readable error vocabulary for v1.
Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited
extraobjectrequired
Structured details such as field errors or SKU availability.
messagestringrequired
Human-readable summary.
429Rate limit exceeded for this API key.
codeErrorCoderequired
Stable machine-readable error vocabulary for v1.
Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited
extraobjectrequired
Structured details such as field errors or SKU availability.
messagestringrequired
Human-readable summary.
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.vault.stashtab.gg/v1/products" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "page_size": 0,
  "count": 0,
  "total": 0,
  "current_page_number": 0,
  "next_page_number": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "previous_page_number": 0,
  "results": [
    {
      "dimensions": {
        "height": 0,
        "length": 0,
        "unit": "in",
        "width": 0
      },
      "image_url": "http://example.com",
      "name": "string",
      "sku": "string",
      "upc": "string",
      "weight": {
        "unit": "oz",
        "value": 0
      },
      "created_at": "2019-08-24T14:15:22Z",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}