Search every article, drafts and internal ones included

Every article in the help centre, whatever its state or visibility.

Drafts, internal and signed_in articles are all included, and that is the point: this is the authoring list, not the visitor one.

Filters combine with AND. q matches the title, category_id narrows to one container, and editorial_state and visibility take one value each. Page with limit and offset. total counts the whole filtered set.

Each row carries the editorial facts a visitor never sees: whether the article is outdated against its source, whether it has been edited locally, and whether an incoming update is in conflict with that edit.

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.

Query Parameters

Response Body

curl -X GET "https://example.com/v1/help-centre/articles"

{  "total": 0,  "limit": 0,  "offset": 0,  "articles": [    {      "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"    }  ]}