Menu Close Menu
Menu
  • 0
    • Number of items in cart: 0

      • Your cart is empty.
      • Total: $0.00
      • Checkout
  • Pricing
    • Purchase Options
    • Individual Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Blog

Articles REST API Route

Articles REST API Route

List articles via 3rd party applications

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.

Articles REST API Route

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…
KB Article rating: 4.0 based on 1 ratings
Developer Docs REST API Last updated: 21/01/2021

Published by Cristian Raiber

Posts by Cristian Raiber

Post navigation

Previous

Ticket Source REST API Route

Next

Replies REST API Route

Contact Details

  • Follow us on Twitter
  • Like us on Facebook
  • Fork us on GitHub

Developer Resources

Plugin Boilerplate

Trello Board

GitHub Repository

Ratings & Satisfaction Docs

  • Configuring Ratings and Satisfaction
  • Advanced Settings

Email Support Docs

  • Plugin Requirements
  • Configuring Email Support
  • Creating New Tickets
  • Replying to Closed Tickets
  • Anonymous Replies in Email Support
  • HTML Emails Tags
  • Email Commands
  • Defining IMAP Flags

KBS REST API Docs

  • Using the REST API
  • Tickets REST API Route
  • Replies REST API Route
  • Articles REST API Route
  • Agents REST API Route
  • Customers REST API Route
  • Companies REST API Route
  • Forms REST API Route
  • Form Fields REST API Route
  • Ticket Categories REST API Route
  • Ticket Departments REST API Route
  • Ticket Source REST API Route

Article Categories

  • Configuration
    • Advanced
    • Getting Started
  • Developer Docs
    • Constants
    • Hooks
  • Extensions
  • FAQs
© 2023 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Privacy Policy
  • Discount Code