Authentication #
Authentication is not required for this route unless attempting to retrieve restricted articles.
Schema #
When working with the Articles REST API route the following fields can be expected in any responses.
id integer |
Unique identifier for the article Read Only |
date string |
The date the article was published, in the site’s timezone |
date_gmt string |
The date the article was published, as GMT |
modified string |
The date the article was last modified, in the site’s timezone |
modified_gmt string |
The date the article was last modified, as GMT |
guid object |
The globally unique identifier for the object. Read only |
slug string |
An alphanumeric identifier for the object unique to its type |
status string |
The named status of the article One of: publish , future , draft , pending , private |
type string |
Type of Post for the object Read only |
title object |
The title of the article |
content object |
The content of the article |
excerpt object |
The excerpt for the object |
author integer |
The ID for the author of the object |
replies integer |
The count of replies associated with the ticket |
links object |
Links associated with the ticket |
List Articles #
Query this endpoint to retrieve a collection of articles. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /kbs/v1/articles
Example Request #
$ curl https://example.com/wp-json/kbs/v1/articles
Arguments #
page |
Current page of the collection Default: 1 |
per_page |
Maximum number of items to be returned in result set Default: 10 |
exclude |
Ensure result set excludes specific article IDs |
include |
Limit result set to specific article IDs |
offset |
Offset the result set by a specific number of items |
order |
Order sort attribute ascending or descending Default: desc One of: asc , desc |
orderby |
Sort collection by object attribute Default: id One of: author , date , id , include , modified , parent , relevance , slug , include_slugs , title , views , views_month |
status string | array |
Limit result set to articles assigned one or more statuses Default: publish |
search string |
Limit results to those matching a string |
Retrieve an Article #
Definition #
GET /kbs/v1/articles/<id>
Example Request #
$ curl https://example.com/wp-json/kbs/v1/articles/<id>
Arguments #
id |
WP Post ID of the ticket |
Was this article helpful?
We're working hard to ensure we provide you with useful and relevant documentation to help you get the most out of KB Support.
Please take a moment to let us know if you found this article helpful.