Skip to content

Categories & Terms

Categories are a type's structured attributes (make, model, color, …); terms are the selectable values within a category.

  • Base URL: /wp-json/dms/v1/
  • All requests require a Bearer API key - see Authentication.

Endpoints

Method Path Capability Purpose
GET categories/{type_id} - Categories (attribute definitions) for a type.
GET category/{category_id} - A single category.
GET terms/{category_id} - Terms available in a category.
GET term/{term_id} - A single term.
GET icons - Available icon set (for category/term display).

GET /categories/{type_id}

All category definitions for a type. The numeric category IDs returned here are the keys used in the listing payload categories object and in create/update writes.

curl "https://your-site.com/wp-json/dms/v1/categories/4" \
  -H "Authorization: Bearer YOUR_KEY"

GET /category/{category_id}

A single category definition by ID.

GET /terms/{category_id}

The terms available within a category - the valid values for that attribute (e.g. every color).

curl "https://your-site.com/wp-json/dms/v1/terms/42" \
  -H "Authorization: Bearer YOUR_KEY"

GET /term/{term_id}

A single term by ID.

GET /icons

The icon set available to categories/terms, for rendering attribute glyphs in a client.

See also

  • Types - resolve a {type_id} first.
  • Listings - write category values on a listing.