Skip to main content

​
Endpoints

GET https://api.voyantcloud.com/v1/products/categories
GET https://api.voyantcloud.com/v1/products/categories/:id
Retrieve product categories for the current workspace. Responses honor the optional lang query param to return translated names/slugs (fallback to the base value when a translation is missing). Results are workspace-scoped and cached for faster repeated reads.

​
Authentication

​
Authorization
string
required
Bearer token with catalog:read or products:read scope (e.g. Authorization: Bearer YOUR_API_KEY)

​
Query parameters

​
lang
string
Locale to use for translations (e.g., en, fr). Defaults to the base category values when omitted.
​
version
integer
default:"1"
Category version. Only for the collection endpoint.

​
Collection: list categories

GET /v1/products/categories
Returns the category tree for the workspace.

​
Response

​
items
array
required
Array of category tree nodes

​
Example

cURL
curl "https://api.voyantcloud.com/v1/products/categories?lang=fr" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Single: get a category

GET /v1/products/categories/:id
Returns a single category with translations applied.

​
Response

​
data
object
required
Category object with translated name/slug when available. Fields match the collection item shape (no children beyond the requested node).

​
Example

cURL
curl "https://api.voyantcloud.com/v1/products/categories/6f8c6f0d-1b2a-4f23-9a6e-123456789abc?lang=es" \
  -H "Authorization: Bearer YOUR_API_KEY"