Skip to main content
Support

List articles

GET https://api.helpdocs.io/v1/article

Example request

Generated
Parameters
curl 'https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND' \
  -H 'Authorization: Bearer YOUR_TOKEN'
curl https://api.helpdocs.io/v1/article \
  -H 'Authorization: Bearer YOUR_TOKEN'
const url = "https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  },
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  },
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND";

const options: RequestInit = {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  },
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article";

const options: RequestInit = {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  },
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
import requests

url = "https://api.helpdocs.io/v1/article"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}

params = {
    "limit": "1",
    "page": "1",
    "skip": "1",
    "include_body": "true",
    "lite": "true",
    "count_only": "true",
    "format": "json",
    "replace_clips": "true",
    "ensure_heading_ids": "true",
    "async": "true",
    "article_id": "string",
    "category_id": "string",
    "tag": "string",
    "permission_group": "string",
    "status": "string",
    "user_id": "string",
    "search_term": "string",
    "language_code": "string",
    "strict_language": "true",
    "is_stale": "true",
    "only_deleted": "true",
    "include_archived": "true",
    "working_copy": "true",
    "has_working_copy": "true",
    "working_copy_user_id": "string",
    "needs_translation": "true",
    "outdated_translation": "true",
    "updated_at_after": "string",
    "updated_at_before": "string",
    "combine_filters": "AND",
    "combine_tags": "AND",
    "combine_permission_groups": "AND",
}

response = requests.get(url, headers=headers, params=params)

print(response.json())
import requests

url = "https://api.helpdocs.io/v1/article"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}

response = requests.get(url, headers=headers)

print(response.json())
<?php

$ch = curl_init("https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
    ],
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
<?php

$ch = curl_init("https://api.helpdocs.io/v1/article");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
    ],
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.helpdocs.io/v1/article", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .GET()
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/article"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .GET()
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND")

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/article")

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.helpdocs.io/v1/article?limit=1&page=1&skip=1&include_body=true&lite=true&count_only=true&format=json&replace_clips=true&ensure_heading_ids=true&async=true&article_id=string&category_id=string&tag=string&permission_group=string&status=string&user_id=string&search_term=string&language_code=string&strict_language=true&is_stale=true&only_deleted=true&include_archived=true&working_copy=true&has_working_copy=true&working_copy_user_id=string&needs_translation=true&outdated_translation=true&updated_at_after=string&updated_at_before=string&combine_filters=AND&combine_tags=AND&combine_permission_groups=AND");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());
var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.helpdocs.io/v1/article");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

{
  "articles": [
    {
      "article_id": "string",
      "account_id": "string",
      "user_id": "string",
      "category_id": "string",
      "author": {
        "name": "string",
        "email": "string",
        "profile_image": "string"
      },
      "title": "string",
      "description": "string",
      "short_version": "string",
      "body": "string",
      "slug": "string",
      "icon": "string",
      "tags": [
        "string"
      ],
      "show_toc": true,
      "is_private": true,
      "is_published": true,
      "is_archived": true,
      "status": "string",
      "archived_at": "2024-01-15T09:30:00Z",
      "archived_by": "string",
      "archive_reason": "string",
      "is_featured": true,
      "related_article_ids": [
        "string"
      ],
      "related_auto": true,
      "is_current_version": true,
      "version_number": 1,
      "source": "string",
      "external_id": "string",
      "editor_type": "string",
      "stale_status": {
        "is_stale": true,
        "reason": "string",
        "source": "string",
        "triggered_at": "2024-01-15T09:30:00Z",
        "expires_at": "2024-01-15T09:30:00Z"
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "permission_groups": [
        "string"
      ],
      "multilingual": [
        {
          "language_code": "string",
          "title": "string",
          "description": "string",
          "short_version": "string",
          "body": "string",
          "slug": "string",
          "tags": [
            "string"
          ],
          "user_id": "string",
          "url": "string",
          "relative_url": "string",
          "is_live": true,
          "is_current_version": true,
          "version_number": 1,
          "editor_type": "string",
          "machine_translated_at": "2024-01-15T09:30:00Z",
          "has_working_copy": true,
          "created_at": "2024-01-15T09:30:00Z",
          "content_token": "string"
        }
      ],
      "url": "string",
      "relative_url": "string",
      "description_was_autogenerated": true,
      "short_version_was_autogenerated": true
    }
  ]
}

The matching articles.

Schemas
string

strict_language is true and language_code names a language the account does not have. The message lists the languages it does have.

Schemas
{
  "code": 1,
  "err": "string"
}

Authentication failed or no API key was supplied.

Schemas
{
  "code": 1,
  "err": "string"
}

The key lacks read permission, or the account’s plan does not include API access.

Schemas
{
  "code": 1,
  "err": "string"
}

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.

Schemas
Generated

Returns the account’s articles, newest first. Bodies are included by default; pass include_body=false for a lighter listing.

Authentication

    • ApiKeyBearer http bearer

      An 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.

    • OAuth2 oauth2

      An 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.

      Scopes read:articles

    • ContentJWT apiKey query: hd_jwt

      A help-center content JWT, for accounts using JWT auth. Accepted as the hd_jwt query parameter or as the hd_jwt cookie, and only on the read operations that declare it. A content JWT does not say which knowledge base it is for, so send account_domain with it: the knowledge base’s HelpDocs subdomain, its custom domain, or its slug.

Query parameters

  • limit integer

    Maximum number of articles to return. Pages count only the articles this credential can see, so a page shorter than limit is the last one.

  • page integer

    Page number, used with limit.

  • skip integer

    Number of articles to skip. An alternative to page.

  • include_body boolean

    Include each article’s body. Defaults to true.

  • lite boolean

    Return a reduced projection, omitting the heavier fields.

See more 27
  • count_only boolean

    Return only the match count.

  • format string

    Rendering of the article body.

    enum "json""markdown""html"

  • replace_clips boolean

    Expand clip references inline in the body.

  • ensure_heading_ids boolean

    Add stable ids to headings in the rendered body.

  • async boolean

    For an export format, generate the file in the background and notify when it is ready rather than waiting.

  • article_id string

    Only these articles. Accepts a comma-separated list of ids.

  • category_id string

    Only articles in these categories. Accepts a comma-separated list.

  • tag string

    Only articles carrying these tags. Accepts a comma-separated list.

  • permission_group string

    Only articles in these permission groups. Accepts a comma-separated list.

  • status string

    Only 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_id string

    Only articles belonging to these users. Accepts a comma-separated list.

  • search_term string

    Free-text filter over title and body.

  • language_code string

    Return this translation of each article.

  • strict_language boolean

    Refuse 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_stale boolean

    Only articles flagged stale.

  • only_deleted boolean

    Return deleted articles instead of live ones.

  • include_archived boolean

    Include archived articles alongside the rest. Archived articles are omitted by default; pass status=archived instead to return only those.

  • working_copy boolean

    Return the unpublished working copy where one exists.

  • has_working_copy boolean

    Only articles that have an unpublished working copy.

  • working_copy_user_id string

    Only 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_translation boolean

    Only articles missing a translation for language_code.

  • outdated_translation boolean

    Only articles whose translation lags the source.

  • updated_at_after string

    Only articles updated after this date, e.g. 2026-01-02.

  • updated_at_before string

    Only articles updated before this date, e.g. 2026-01-02.

  • combine_filters string

    Whether every filter must match or any one of them. Defaults to AND.

    enum "AND""OR"

  • combine_tags string

    Whether every listed tag must match or any one of them. Defaults to AND.

    enum "AND""OR"

  • combine_permission_groups string

    Whether every listed permission group must match or any one. Defaults to AND.

    enum "AND""OR"

Responses

200

The matching articles.

application/json ArticlesResponse
  • articles array of Article Required
400

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.

401

Authentication failed or no API key was supplied.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

403

The key lacks read permission, or the account’s plan does not include API access.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

429

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.

headers

  • Retry-After integer
  • X-RateLimit-Limit integer
  • X-RateLimit-Remaining integer
  • X-RateLimit-Reset integer
application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

All endpoints