KnowledgeBaseArticle

Find articles By Category Id.

GET

http://localhost:3000/api/help-center-article/category/{categoryId}

curl -X GET 'http://localhost:3000/api/help-center-article/category/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/help-center-article/category/string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/help-center-article/category/string',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "data": "string",
  "draft": true,
  "privacy": true,
  "index": 0,
  "descriptionHtml": "string",
  "descriptionJson": {},
  "descriptionBinary": "string",
  "isLocked": true,
  "color": "string",
  "externalId": "string",
  "categoryId": "string",
  "parentId": "string",
  "ownedById": "string",
  "projects": [
    []
  ],
  "tags": [
    []
  ]
}

Parameters

categoryIdstringrequiredpath

Response

200OKHelpCenterArticle

Found category articles

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstring

datastring

draftboolean

privacyboolean

indexnumberrequired

descriptionHtmlstring

descriptionJsonobject

descriptionBinarystring

isLockedboolean

colorstring

externalIdstring

categoryIdstringrequired

parentIdstring

ownedByIdstring

projectsArray<array>

tagsArray<array>

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo