Show Section

GET {{baseUrl}}/api/v2/help_center/:locale/sections/:section_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
categoriesthe category
translationsthe section and category translations, if any

Unlike other sideloads, translations are embedded within the section since they're not shared between resources. Category translations are only sideloaded if categories are.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"section":{"name":"\u003cstring\u003e","locale":"\u003cstring\u003e","category_id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","description":"\u003cstring\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","outdated":"\u003cboolean\u003e","parent_section_id":"\u003cinteger\u003e","position":"\u003cinteger\u003e","source_locale":"\u003cstring\u003e","theme_template":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e"}}