Read complete categories configuration

GET /categories//configuration. Required scopes: categories:read.

GET /api/public/v1/categories/{category_id}/configuration

Read complete categories configuration

cURL

curl --request GET \
  --url https://wisepim.com/api/public/v1/categories/{category_id}/configuration \
  --header 'Authorization: Bearer <token>'

200

{
  "name": "<string>",
  "parent": 1,
  "description": "<string>",
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_keywords": "<string>",
  "is_active": true,
  "sort_order": 123,
  "name_localized": "<unknown>",
  "description_localized": "<unknown>",
  "meta_title_localized": "<unknown>",
  "meta_description_localized": "<unknown>",
  "meta_keywords_localized": "<unknown>",
  "industry_slug": "<string>",
  "faqs": "<unknown>",
  "faqs_localized": "<unknown>",
  "append_faqs_to_products": true,
  "id": 123
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Path Parameters

category_id · integer · required

Response

200

application/json

OK

name · string · required

Maximum string length: 255

parent · integer | null · required

Required range: x > 0

description · string | null · required

meta_title · string | null · required

Maximum string length: 255

meta_description · string | null · required

meta_keywords · string | null · required

Maximum string length: 255

is_active · boolean · required

sort_order · integer · required

name_localized · any · required

Localized category names keyed by locale code

description_localized · any · required

Localized category descriptions keyed by locale code

meta_title_localized · any · required

Localized meta titles keyed by locale code

meta_description_localized · any · required

Localized meta descriptions keyed by locale code

meta_keywords_localized · any · required

Localized meta keywords keyed by locale code

industry_slug · string | null · required

Optional industry override for scoring products under this category. Empty falls back to the project's primary_industry.

Maximum string length: 50

faqs · any · required

Ordered FAQ items: [{"id", "question", "answer"}]. Answers are limited HTML.

faqs_localized · any · required

FAQ translations keyed by locale, then FAQ id

append_faqs_to_products · boolean · required

Append this category's FAQs to the FAQs of every product directly in it

id · integer · required