Authentication #
No authentication is required for this route.
Schema #
When working with the Form Fields REST API route the following fields can be expected in any responses.
idinteger | Unique identifier for the field Read Only |
datestring | The date the field was published, in the site’s timezone |
date_gmtstring | The date the field was published, as GMT |
modifiedstring | The date the field was last modified, in the site’s timezone |
modified_gmtstring | The date the field was last modified, as GMT |
titleobject | The title of the field |
parentinteger | The post parent ID |
menu_orderinteger | Menu order |
metainteger | Meta fields |
linksobject | Links associated with the ticket |
List Fields #
Query this endpoint to retrieve a collection of fields. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /kbs/v1/forms/fields
Example Request #
$ curl https://example.com/wp-json/kbs/v1/forms/fields
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, parent, menu_order |
statusstring | array | Limit result set to fields assigned one or more statuses Default: publish |
slug | Limit result set to fields with one or more specific slugs |
parent | Limit result set to fields with particular parent IDs |
parent_exclude | Limit result set to all fields except those of a particular parent ID |
Retrieve a Single Field #
Definitions #
GET /kbs/v1/forms/fields/<id>
Example Request #
$ curl https://example.com/wp-json/kbs/v1/forms/fields/<id>
Arguments #
id | WP Post ID of the field |
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.
