Get one article translation for editing
One translation, with its editorial and sanitiser metadata.
/v1/help-centre/articles/{translation_id}Viewer- Operation id
- get_by_id
- Access
- Any workspace role can call this.
/v1/help-centre/articles/{translation_id}One translation, with its editorial and sanitiser metadata.
This is what an editor screen loads. body_markdown is the editable text
and body_html is what a visitor would be served, which is the sanitised
render. The unsanitised text imported from another system is never
returned by any route.
sanitize_report, link_report and asset_report say what the sanitiser
removed or rewrote. has_conflict means an update arrived from the source
after somebody edited this article here, and the two versions are waiting
to be compared.
The id is a translation id, one per locale, not the article id.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the help-centre-staff:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
uuidQuery Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/help-centre/articles/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "article_id": "string", "translation_id": "string", "locale": "string", "title": "string", "slug": "string", "excerpt": "string", "container_path": "string", "url": "string", "position": 0, "promoted": true, "breadcrumbs": [ { "name": "string", "path": "string", "url": "string" } ], "updated_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z", "vote_count": 0, "vote_sum": 0, "visibility": "string", "editorial_state": "string", "source_visibility_raw": {}, "permission_group_id": "string", "user_segment_ids": [ "string" ], "outdated": true, "outdated_locales": [ "string" ], "missing_at_source_at": "2019-08-24T14:15:22Z", "locally_edited_at": "2019-08-24T14:15:22Z", "has_conflict": true, "conflict_seen_at": "2019-08-24T14:15:22Z", "body_html": "string", "body_markdown": "string", "body_format": "string", "sanitizer_version": "string", "sanitize_report": {}, "link_report": {}, "asset_report": {}, "source_status_raw": "string", "canonical_url": "string", "alternates": [ { "locale": "string", "url": "string" } ], "author_label": "string", "labels": [ "string" ], "source_url": "string", "source_created_at": "2019-08-24T14:15:22Z", "source_updated_at": "2019-08-24T14:15:22Z", "noindex": true}