Skip to main content
GET
/
articles
List all articles
curl --request GET \
  --url https://{your-subdomain}.neetokb.com/api/external/v1/articles \
  --header 'X-Api-Key: <x-api-key>'
import requests

url = "https://{your-subdomain}.neetokb.com/api/external/v1/articles"

headers = {"X-Api-Key": "<x-api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetokb.com/api/external/v1/articles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{your-subdomain}.neetokb.com/api/external/v1/articles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://{your-subdomain}.neetokb.com/api/external/v1/articles"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-Api-Key", "<x-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{your-subdomain}.neetokb.com/api/external/v1/articles")
.header("X-Api-Key", "<x-api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetokb.com/api/external/v1/articles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
{
  "articles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "unique_views_count": 42,
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

category_id
string<uuid>

Unique identifier of the category. Refer to Getting the Category ID section for detailed instructions.

page_number
integer

Retrieve paginated results by specifying the desired page number. Defaulting to 1 when omitted.

page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

search_term
string

Search term to filter articles.

state
enum<string>

Status of the article.

Available options:
draft,
published

Response

200 - application/json

OK - Request succeeded

articles
object[]
pagination
object