List Translations
GET {{baseUrl}}/api/v2/help_center/articles/:article_id/translations?locales=<string>&outdated=<boolean>&draft=<boolean>
Lists all translations for a given article, section, or category.
Allowed for
- End users
For end users, the response will list only the translations for articles, sections, or categories that they can view in Help Center.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
locales | string | The value given is a comma-separated list of locale names; | |
| only return translations in those locales | |||
outdated | string | Only return translations with the given outdated status | |
draft | string | Only return translations with the given draft status |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"translations":[{"locale":"\u003cstring\u003e","title":"\u003cstring\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","created_by_id":"\u003cinteger\u003e","draft":"\u003cboolean\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","outdated":"\u003cboolean\u003e","source_id":"\u003cinteger\u003e","source_type":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","updated_by_id":"\u003cinteger\u003e","url":"\u003cstring\u003e"},{"locale":"\u003cstring\u003e","title":"\u003cstring\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","created_by_id":"\u003cinteger\u003e","draft":"\u003cboolean\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","outdated":"\u003cboolean\u003e","source_id":"\u003cinteger\u003e","source_type":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","updated_by_id":"\u003cinteger\u003e","url":"\u003cstring\u003e"}]}