Sign in
Knowledge Articles

Retrieve a Knowledge Article

OAuth Scope

This endpoint requires the following OAuth scope read_knowledge.

get/knowledgearticle/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Knowledge Article

Response

Knowledge Article record

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

namestring required

Title of the knowledge article. This is a mandatory field with a maximum length of 100 characters. Used for identifying and searching for articles in the knowledge base.

contentstring

The main content of the knowledge article. For 'richtext' articles, this contains HTML formatted text. For 'video' articles, this may contain supplementary information. For 'call' articles, this contains call details. Supports extended text length.

article_typestring

Type of knowledge article. Valid values are 'video', 'richtext', or 'call'. This determines how the article content is presented and processed in the system.

tagsstring

Comma-separated list of tags associated with this knowledge article. Maximum length is 2000 characters. Tags are used for categorization, searching, and automatic relationship generation with other objects like Services, Materials, and Companies.

Example response

{
  "uuid": "123e4567-b2b6-4457-b8e1-2318489891cb",
  "edit_date": "2025-08-01 12:00:00"
}

Changes