List articles
Example request
Generated- cURL
- JavaScript
- TypeScript
- Python
- PHP
- Go
- Java
- Ruby
- C#
Responses
Returns the account’s articles, newest first. Bodies are included by default; pass include_body=false for a lighter listing.
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
-
-
OAuth2oauth2An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as
Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.
-
-
-
ContentJWTapiKeyquery: hd_jwtA help-center content JWT, for accounts using JWT auth. Accepted as the
hd_jwtquery parameter or as thehd_jwtcookie, and only on the read operations that declare it. A content JWT does not say which knowledge base it is for, so sendaccount_domainwith it: the knowledge base’s HelpDocs subdomain, its custom domain, or its slug.
-
Query parameters
-
limitintegerMaximum number of articles to return. Pages count only the articles this credential can see, so a page shorter than limit is the last one.
-
pageintegerPage number, used with limit.
-
skipintegerNumber of articles to skip. An alternative to page.
-
include_bodybooleanInclude each article’s body. Defaults to true.
-
litebooleanReturn a reduced projection, omitting the heavier fields.
See more 27
-
count_onlybooleanReturn only the match count.
-
formatstringRendering of the article body.
-
replace_clipsbooleanExpand clip references inline in the body.
-
ensure_heading_idsbooleanAdd stable ids to headings in the rendered body.
-
asyncbooleanFor an export format, generate the file in the background and notify when it is ready rather than waiting.
-
article_idstringOnly these articles. Accepts a comma-separated list of ids.
-
category_idstringOnly articles in these categories. Accepts a comma-separated list.
-
tagstringOnly articles carrying these tags. Accepts a comma-separated list.
-
permission_groupstringOnly articles in these permission groups. Accepts a comma-separated list.
-
statusstringOnly articles with these statuses: published, draft, or private. Archived articles are omitted unless status=archived or include_archived=true is passed. Accepts a comma-separated list.
-
user_idstringOnly articles belonging to these users. Accepts a comma-separated list.
-
search_termstringFree-text filter over title and body.
-
language_codestringReturn this translation of each article.
-
strict_languagebooleanRefuse a language_code the account does not have with a 400, instead of answering in the default language. GET /v1/languages lists the codes the account has. Defaults to false.
-
is_stalebooleanOnly articles flagged stale.
-
only_deletedbooleanReturn deleted articles instead of live ones.
-
include_archivedbooleanInclude archived articles alongside the rest. Archived articles are omitted by default; pass status=archived instead to return only those.
-
working_copybooleanReturn the unpublished working copy where one exists.
-
has_working_copybooleanOnly articles that have an unpublished working copy.
-
working_copy_user_idstringOnly articles with an unpublished working copy in language_code that belongs to one of these users: they wrote the article, or made the latest edit to the working copy. Always combined with AND, whatever combine_filters says. Accepts a comma-separated list of ids.
-
needs_translationbooleanOnly articles missing a translation for language_code.
-
outdated_translationbooleanOnly articles whose translation lags the source.
-
updated_at_afterstringOnly articles updated after this date, e.g. 2026-01-02.
-
updated_at_beforestringOnly articles updated before this date, e.g. 2026-01-02.
-
combine_filtersstringWhether every filter must match or any one of them. Defaults to AND.
-
combine_tagsstringWhether every listed tag must match or any one of them. Defaults to AND.
-
combine_permission_groupsstringWhether every listed permission group must match or any one. Defaults to AND.
Responses
The matching articles.
application/json
ArticlesResponse
strict_language is true and language_code names a language the account does not have. The message lists the languages it does have.
text/plain
The failure, as a human-readable message.
-
string
The failure, as a human-readable message.
Authentication failed or no API key was supplied.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The key lacks read permission, or the account’s plan does not include API access.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.
-
Retry-Afterinteger -
X-RateLimit-Limitinteger -
X-RateLimit-Remaininginteger -
X-RateLimit-Resetinteger
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.