Skip to main content
Support

List categories

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

Example request

Generated
Parameters
curl 'https://api.helpdocs.io/v1/category?language_code=string&strict_language=true&include=article_counts' \
  -H 'Authorization: Bearer YOUR_TOKEN'
curl https://api.helpdocs.io/v1/category \
  -H 'Authorization: Bearer YOUR_TOKEN'
const url = "https://api.helpdocs.io/v1/category?language_code=string&strict_language=true&include=article_counts";

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/category";

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/category?language_code=string&strict_language=true&include=article_counts";

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/category";

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/category"

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

params = {
    "language_code": "string",
    "strict_language": "true",
    "include": "article_counts",
}

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

print(response.json())
import requests

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

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

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

print(response.json())
<?php

$ch = curl_init("https://api.helpdocs.io/v1/category?language_code=string&strict_language=true&include=article_counts");

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/category");

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/category?language_code=string&strict_language=true&include=article_counts", 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/category", 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/category?language_code=string&strict_language=true&include=article_counts"))
            .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/category"))
            .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/category?language_code=string&strict_language=true&include=article_counts")

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/category")

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/category?language_code=string&strict_language=true&include=article_counts");
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/category");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");

var response = await client.SendAsync(request);

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

Responses

{
  "categories": [
    {
      "category_id": "string",
      "account_id": "string",
      "parent_category_id": "string",
      "title": "string",
      "description": "string",
      "slug": "string",
      "is_featured": true,
      "icon": "string",
      "external_id": "string",
      "multilingual": [
        {
          "language_code": "string",
          "title": "string",
          "description": "string",
          "slug": "string"
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "permission_groups": [
        "string"
      ],
      "enforce_permissions": true,
      "url": "string",
      "relative_url": "string",
      "live_article_count": 1,
      "archived_article_count": 1,
      "name_only": true
    }
  ]
}

The account’s categories, as a flat list. Each category’s parent_category_id says where it sits in the tree.

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

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:categories

    • 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

  • language_code string

    Return this translation of each category.

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

  • include string

    article_counts adds live_article_count to each category: how many live, unarchived articles sit directly in it.

    enum "article_counts"

Responses

200

The account’s categories, as a flat list. Each category’s parent_category_id says where it sits in the tree.

application/json CategoriesResponse
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