​
What is an article identifier?

Article identifiers are unique values used to reference specific articles in your knowledge base when making API requests. Understanding the different types of identifiers and how to find them is essential for working with the NeetoKB API. NeetoKB supports three types of identifiers for articles, each serving different purposes:
  • ID (UUID) - Permanent unique identifier. Example: 285c4bab-3ca4-4a24-9288-73392a04554e
  • Slug - Human-readable URL identifier. Example: getting-started-guide
  • Permalink - Stable short identifier for updates. Example: a-d17829fc
There are two main ways to get article identifiers:
  • Using the API - Programmatically retrieve all articles and their identifiers.
  • From the URL - Extract identifier directly from your browser’s address bar.
Permalinks cannot be retrieved via the API or extracted from the URL. Refer to the help article for more information.

​
Method 1: Using the API Endpoint

The List all articles API endpoint allows you to retrieve a list of all articles in your workspace, including their identifiers. This is particularly useful when you need to programmatically access or retrieve the identifiers of all available articles.

​
Step-by-Step Instructions

1

Make the API request

Send a GET request to the List all articles API endpoint, including your API key in the request header.
2

Parse the response

The response will contain an array of articles, each with id, slug, and other fields.Example:
{
  "articles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "unique_views_count": 123,
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Tutorials"
      }
    },
    // ... rest of the articles
  ],
  "total_count": 123,
  "match_count": 123
}
3

Extract the article identifier

Here the article identifiers for the Getting Started Guide are:
  • ID: 3c90c3cc-0d44-4b50-8888-8dd25736052a
  • Slug: getting-started
You can access the article identifiers in your code from the response using:
// Get the first article's ID
const articleId = response.articles[0].id;

// Or iterate through all articles to find a specific one
const startedGuide = response.articles.find(article =>
  article.title === "Getting Started Guide"
);
const startedGuideId = startedGuide.id;
const startedGuideSlug = startedGuide.slug;
The articles array contains all articles in your workspace. If you have multiple articles, you may want to filter by title or other properties to find the specific article you need.

​
Method 2: From the URL

Article identifiers appear in the URL when you view an article in your workspace. This method provides only the slug, not the article’s ID or permalink. For example, in the URL: 
https://spinkart.neetokb.com/admin/categories/product-guides/articles/getting-started-guide/edit
The article slug is: getting-started-guide

​
Step-by-Step Instructions

1

Navigate to your article

Log into your NeetoKB workspace and navigate to the article you want to work with.
2

Locate the article URL

Once you’re viewing the article, look at your browser’s address bar. The URL will contain the article identifier.
3

Extract the article identifier

The article identifier is typically found in the URL path. Look for a pattern like:
https://your-subdomain.neetokb.com/admin/categories/product-guides/articles/{article-identifier}/edit
The {article-identifier} part is what you need.

​
Examples

Here are some examples of how article identifiers appear in URLs & permalinks:
URL ExampleArticle Identifier
https://mycompany.neetokb.com/admin/categories/getting-started/articles/user-guide/edituser-guide
https://support.neetokb.com/admin/categories/faq/articles/troubleshooting-tips/edittroubleshooting-tips
https://docs.neetokb.com/admin/categories/developer-guides/articles/api-integration-guide/editapi-integration-guide
Permalink ExampleArticle Identifier
https://mycompany.neetokb.com/p/a-84af178ba-84af178b
https://support.neetokb.com/p/b-93cd289fb-93cd289f
https://docs.neetokb.com/p/c-47de12acc-47de12ac