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.

id
integer
Unique identifier for the field
Read Only
date
string
The date the field was published, in the site’s timezone
date_gmt
string
The date the field was published, as GMT
modified
string
The date the field was last modified, in the site’s timezone
modified_gmt
string
The date the field was last modified, as GMT
title
object
The title of the field
parent
integer
The post parent ID
menu_order
integer
Menu order
meta
integer
Meta fields
links
object
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: desc
One of: ascdesc
orderby Sort collection by object attribute
Default: title
One of: iddate, modifiedinclude, title, parent, menu_order
status
string | 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?