Authentication #
No authentication is required for this route.
Schema #
When working with the Forms REST API route the following fields can be expected in any responses.
idinteger | Unique identifier for the form Read Only |
datestring | The date the form was published, in the site’s timezone |
date_gmtstring | The date the form was published, as GMT |
modifiedstring | The date the form was last modified, in the site’s timezone |
modified_gmtstring | The date the form was last modified, as GMT |
statusstring | The named status of the form One of: publish, future, draft, pending, private |
titleobject | The title of the form |
metaobject | Meta fields |
fieldsobject | Form fields |
linksobject | Links associated with the ticket |
List Forms #
Query this endpoint to retrieve a collection of forms. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /kbs/v1/forms
Example Request #
$ curl https://example.com/wp-json/kbs/v1/forms
Arguments #
page | Current page of the collection Default: 1 |
per_page | Maximum number of items to be returned in result set Default: 10 |
search | Limit results to those matching a string |
exclude | Ensure result set excludes specific post IDs |
include | Limit result set to specific post IDs |
offset | Offset the result set by a specific number of items |
order | Order sort attribute ascending or descending Default: descOne of: asc, desc |
orderby | Sort collection by object attribute Default: titleOne of: id, date, modified, include, title |
statusstring | array | Limit result set to forms assigned one or more statuses Default: publish |
slug | Limit result set to posts with one or more specific slugs |
Retrieve a Single Form #
Definitions #
GET /kbs/v1/forms/<id>
Example Request #
$ curl https://example.com/wp-json/kbs/v1/forms/<id>
Arguments #
id | WP Post ID of the form |
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.
