V1 and V2 API reference overview
This is the reference for Plytix's V1 API, plus the small set of V2 (beta) endpoints that mirror some V1 product operations with a slightly different shape.
Every request here uses bearer-token authentication: get a token from POST /auth/api/get-token and send it as Authorization: Bearer <token>.
Core concepts
Before integrating with a specific resource, review these fundamental patterns. They apply to every V1 and V2 endpoint.
Authentication
Get and use a bearer token for every request.
Errors and status codes
Understand the success and error response formats.
Rate limits
See how request limits work and what a 429 means.
Filtering and search
Write search bodies with filters, operators, and relationship filters.
Pagination
Page through results and read the counts a search returns.
Available services
Each resource below links to its endpoints, with request and response schemas and examples.
Authentication
Get a bearer token from the V1 auth endpoint.
Accounts
Search account memberships and API credentials.
Assets
Upload, search, update, and delete digital assets.
Categories
Manage both asset and product category trees.
Products (V1)
Create, update, delete, and search products, plus their variants, assets, categories, and relationships.
Products (V2 beta)
The same product operations under /api/v2, with minor request/response differences from V1.
Relationships
Create and manage relationships between products.
Product Families
Manage product families and the attributes linked to them.
Product Attributes
Create and manage custom product attributes.
Product Attribute Groups
Organize product attributes into groups.
Available Filters
Look up which fields are filterable for assets, products, and relationships.
About this reference
This reference was generated from Plytix's internal V1 Postman collection, not from a machine-readable spec, so request/response schemas and examples are inferred from that collection's saved examples rather than a live source of truth. Cross-check against the live API with a real request before relying on an exact field name or type.