Show Category

GET {{baseUrl}}/api/v2/help_center/:locale/categories/:category_id

Note: {/locale} is an optional parameter for admins and agents. End users and anonymous users must provide the parameter.

Allowed for

  • Anonymous users

Sideloads

The following sideloads are supported:

NameWill sideload
translationsthe category translations, if any

Translations are embedded within the category because they're not shared between resources.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"category":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","locale":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","html_url":"\u003cstring\u003e","outdated":"\u003cboolean\u003e","position":"\u003cinteger\u003e","source_locale":"\u003cstring\u003e","updated_at":"\u003cdateTime\u003e","url":"\u003cstring\u003e"}}