List Pinned Articles

GET

/knowledge-base/articles/pinned

GET

/knowledge-base/articles/pinned

1 curl -G https://https//https/knowledge-base/articles/pinned \
2      -H "{{tenant_key_name}}: X-Tenant-ID" \
3      -H "Content-Type: application/json" \
4      -d kb_category_id=a3f47c9e-8b2d-4f1a-9c3e-2d7b5f6a1e4c

200Retrieved

1 {
2   "pinnedArticles": [
3     {
4       "id": "d9f1c2a7-3b4e-4f6a-8c9d-123456789abc",
5       "title": "How to Reset Your Password",
6       "summary": "Step-by-step guide to reset your account password securely.",
7       "categoryId": "a3f47c9e-8b2d-4f1a-9c3e-2d7b5f6a1e4c",
8       "pinned": true,
9       "createdAt": "2024-05-10T09:15:00Z",
10       "updatedAt": "2024-05-15T12:00:00Z"
11     },
12     {
13       "id": "e4b2d3f9-7a8c-4e5f-b1d2-9876543210fe",
14       "title": "Getting Started with PropelBiz",
15       "summary": "Introduction to the main features and how to get started quickly.",
16       "categoryId": "b7c8d9e0-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
17       "pinned": true,
18       "createdAt": "2024-04-20T14:30:00Z",
19       "updatedAt": "2024-05-01T08:45:00Z"
20     }
21   ]
22 }

Headers

{{tenant_key_name}}stringOptional

Query parameters

kb_category_idstringOptional

Optional: Filter pinned articles by category UUID

Response

Successful response