customer-engagement
knowledge-base
knowledge-base-articles

Get article

Returns the full details of a specific article including its content, metadata, and tags. Optionally records a view for analytics.

get/knowledge-base/1/articles/{articleId}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

articleIdstring uuid required

Unique identifier of the article.

Query parameters

recordViewboolean

Whether to record a page view for analytics.

Response

Article details returned successfully

idstring uuid required

Unique identifier of the article.

namestring required

Name of the article.

contentstring required

Content of the article in HTML format.

status'PUBLISHED' | 'DRAFT' required

Workflow status of the article.

lastPublishedAtstring date-time

Timestamp of when the article was last published.

createdAtstring date-time required

Timestamp of when the article was created.

lastUpdatedAtstring date-time required

Timestamp of when the article was last updated.

likeCountinteger required

Count of positive feedbacks.

likedByUserboolean

Whether the current user has liked this article. Null when no user context is available.

viewCountinteger required

Total view count.

subscribedByUserboolean

Whether the current user is subscribed to this article. Null when no user context is available.

scope'INTERNAL' | 'EXTERNAL' required

Content scope of the node.

source'CSV' | 'SHAREPOINT' | 'CONFLUENCE'

External source of the node, if imported.

breadcrumbstring[] required

Navigation breadcrumb path.

commentsCountinteger

Number of comments on the article.

visibility'PRIVATE' | 'PUBLIC' required

Visibility of the node.

publicContentUrlstring

URL to the public content page.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Getting Started with SMS API",
  "content": "<h1>Introduction</h1><p>This guide covers the basics of the SMS API.</p>",
  "status": "PUBLISHED",
  "tags": [
    {
      "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
      "name": "sms"
    }
  ],
  "links": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "API Reference Guide.pdf",
      "type": "ARTICLE"
    }
  ],
  "lastPublishedAt": "2025-06-15T12:00:00Z",
  "createdAt": "2025-06-01T08:30:00Z",
  "lastUpdatedAt": "2025-06-15T14:20:00Z",
  "likeCount": 12,
  "viewCount": 350,
  "subscribedByUser": true,
  "scope": "INTERNAL",
  "source": "CONFLUENCE",
  "category": {
    "name": "API Guides",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "createdBy": {
    "encryptUserId": "a1b2c3d4e5f6",
    "firstName": "John",
    "lastName": "Doe"
  },
  "folder": {
    "name": "Getting Started",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "breadcrumb": [
    "Documentation",
    "API Guides"
  ],
  "lastUpdatedBy": {
    "encryptUserId": "a1b2c3d4e5f6",
    "firstName": "John",
    "lastName": "Doe"
  },
  "lastPublishedBy": {
    "encryptUserId": "a1b2c3d4e5f6",
    "firstName": "John",
    "lastName": "Doe"
  },
  "commentsCount": 5,
  "visibility": "PUBLIC",
  "publicContentUrl": "https://kb.infobip.com/articles/3fa85f64"
}

Changes

No recorded changes to this operation across all 1 revision of this API.