ClientSphereDocs
API reference/Knowledge Base

List articles

Returns a paginated list of knowledge base articles, internal ones included. Filter on visibility yourself if you only want the public, customer-facing set.

GET
/knowledge-base/articles

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1
limitinteger

Items per page (max 100)

Default: 20Maximum: 100
searchstring

Search term

categoryIdstring
Format: "uuid"
statusstring

Exact status match, e.g. draft or published.

curl -X GET "https://clientsphere.io/api/v1/knowledge-base/articles?page=1&limit=20&search=%3Cstring%3E&categoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of articles

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
      "title": "string",
      "slug": "string",
      "content": "string",
      "excerpt": "string",
      "tags": "string",
      "status": "published",
      "visibility": "public",
      "authorId": 0,
      "lastEditedBy": 0,
      "viewCount": 0,
      "isHelpful": 0,
      "isNotHelpful": 0,
      "sortOrder": 0,
      "seoTitle": "string",
      "seoDescription": "string",
      "publishedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

Previous

Get quote GET

Next

List categories GET