Skip to content
Convor
Convor Docs
API ReferenceKnowledge Base

List localized knowledge-base articles

Returns a paginated list of knowledge-base articles resolved for the requested locale.

GET/api/kb/articles

Returns a paginated list of knowledge-base articles resolved for the requested locale. Filter by publication status or category, then paginate with offset and limit. Each item includes localization lifecycle metadata.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
knowledge-base:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
channel?string

Query parameter. Channel. Allowed values: widget, messenger, instagram, whatsapp, allegro, email.

Value in

  • "widget"
  • "messenger"
  • "instagram"
  • "whatsapp"
  • "allegro"
  • "email"
accountId?string

Query parameter. Unique identifier of the related account.

Length1 <= length <= 200
locale?string

Query parameter. BCP 47 locale or language tag used for localized content.

Length1 <= length <= 35
search?string

Query parameter. Search text.

Length1 <= length <= 500
categoryId?string

Query parameter. Unique identifier of the related category.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
status?string

Query parameter. Status. Allowed values: draft, reviewed, published.

Value in

  • "draft"
  • "reviewed"
  • "published"
sortBy?string

Query parameter. Sort by. Allowed values: createdAt, updatedAt, title, topicHandling, topicPriority, conversationTag, status.

Default"updatedAt"

Value in

  • "createdAt"
  • "updatedAt"
  • "title"
  • "topicHandling"
  • "topicPriority"
  • "conversationTag"
  • "status"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "b9a6e922-23ed-4dde-99e8-76d0cf2a0038",      "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",      "categoryId": "6ecda99e-e055-46bd-b0fb-d33ed475b00b",      "tags": [        "billing",        "refund"      ],      "title": "How refunds work",      "slug": "how-refunds-work",      "content": "Refunds are reviewed and returned to the original payment method.",      "status": "published",      "locale": "en",      "fallbackUsed": false,      "translations": [        {          "id": "a5bd4fbf-3bc3-414a-87ca-dd3f96098ea3",          "locale": "en",          "status": "published",          "sourceLocale": null,          "machineTranslatedAt": null,          "reviewedAt": null,          "reviewedBy": null,          "handoffMessage": "Example customer-support message.",          "handoffOfflineMessage": "Example customer-support message.",          "title": "How refunds work",          "slug": "how-refunds-work",          "content": "Refunds are reviewed and returned to the original payment method.",          "createdAt": "2026-08-03T18:00:00.000Z",          "updatedAt": "2026-08-03T18:00:00.000Z"        }      ],      "deletedAt": null,      "createdAt": "2026-08-03T18:00:00.000Z",      "updatedAt": "2026-08-03T18:00:00.000Z",      "ownerOperatorId": "3f042a6a-579c-4c21-9fd4-c3a8323d5caf",      "ownerName": "Alex Morgan",      "topicHandling": "answer",      "topicPriority": null,      "conversationTag": "billing",      "feedback": {        "helpfulCount": 1,        "notHelpfulCount": 0,        "feedbackCount": 1,        "helpfulnessPercent": 100      }    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  },  "quota": {    "usage": {      "articles": 46,      "optimizedBytes": 80000,      "optimizedTokens": 20000    },    "limit": {      "supportPlan": "scale",      "articles": 1000,      "optimizedTokens": 28000    }  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/kb/articles' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/kb/articles", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

List localized categories with published article counts

Returns a paginated category collection resolved for the requested locale, with the number of published articles in each category.

List localized knowledge-base categories

Returns all knowledge-base categories for the authenticated organization, resolved for the requested locale.

On this page

Request examplescurlJavaScript