Show Article
GET {{baseUrl}}/api/v2/help_center/:locale/articles/:article_id
Shows the properties of an article.
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:
Name | Will sideload |
---|---|
users | the author |
sections | the section |
categories | the category |
translations | the article, section and category translations, if any |
Unlike other sideloads, translations are embedded within the article because they're not shared between resources. Section and category translations are only sideloaded if present.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"article":{"title":"\u003cstring\u003e","locale":"\u003cstring\u003e","user_segment_id":"\u003cinteger\u003e","permission_group_id":"\u003cinteger\u003e","author_id":"\u003cinteger\u003e","body":"\u003cstring\u003e","comments_disabled":"\u003cboolean\u003e","content_tag_ids":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cstring\u003e","draft":"\u003cboolean\u003e","edited_at":"\u003cstring\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","label_names":["\u003cstring\u003e","\u003cstring\u003e"],"outdated":"\u003cboolean\u003e","outdated_locales":["\u003cstring\u003e","\u003cstring\u003e"],"position":"\u003cinteger\u003e","promoted":"\u003cboolean\u003e","section_id":"\u003cinteger\u003e","source_locale":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"}}