Skip to main content
GET
Knowledge articles with the body of their current version.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
code
string
title
string
summary
string
article_type
string
status
string
asset_category_id
string
asset_category
string
failure_code
string
current_version_number
string
body
string
published_at
string
author_user_id
string
author
string
reviewed_by_user_id
string
reviewed_by
string
reviewed_at
string
view_count
string
helpful_count
string
unhelpful_count
string
usefulness
string
is_available_offline
string
archive_reason
string
archived_at
string
archived_by_user_id
string
archived_by
string
pending_version_number
string
pending_status
string
created_at
string
updated_at
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

archive_reason
string<character varying>
Maximum string length: 500
archived_at
string<timestamp with time zone>
archived_by
string<character varying>
Maximum string length: 200
archived_by_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

article_type
string<character varying>
Maximum string length: 30
asset_category
string<character varying>
Maximum string length: 200
asset_category_id
string<uuid>

Note: This is a Foreign Key to asset_categories.id.

author
string<character varying>
Maximum string length: 200
author_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

body
string<text>
code
string<character varying>
Maximum string length: 60
created_at
string<timestamp with time zone>
current_version_number
integer<integer>
failure_code
string<character varying>
Maximum string length: 80
helpful_count
integer<integer>
id
string<uuid>

Note: This is a Primary Key.

is_available_offline
boolean<boolean>
pending_status
string<character varying>
Maximum string length: 20
pending_version_number
integer<integer>
published_at
string<timestamp with time zone>
reviewed_at
string<timestamp with time zone>
reviewed_by
string<character varying>
Maximum string length: 200
reviewed_by_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

row_version
integer<bigint>
status
string<character varying>
Maximum string length: 20
summary
string<character varying>
Maximum string length: 500
title
string<character varying>
Maximum string length: 250
unhelpful_count
integer<integer>
updated_at
string<timestamp with time zone>
usefulness
number<numeric>
view_count
integer<integer>