Forms REST API Route

No authentication is required for this route.

When working with the Forms REST API route the following fields can be expected in any responses.

`id` integer	Unique identifier for the form Read Only
`date` string	The date the form was published, in the site’s timezone
`date_gmt` string	The date the form was published, as GMT
`modified` string	The date the form was last modified, in the site’s timezone
`modified_gmt` string	The date the form was last modified, as GMT
`status` string	The named status of the form One of: `publish`, `future`, `draft`, `pending`, `private`
`title` object	The title of the form
`meta` object	Meta fields
`fields` object	Form fields
`links` object	Links associated with the ticket

Query this endpoint to retrieve a collection of forms. The response you receive can be controlled and filtered using the URL query parameters below.

GET /kbs/v1/forms

$ curl https://example.com/wp-json/kbs/v1/forms

`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: `asc`, `desc`
`orderby`	Sort collection by object attribute Default: `title` One of: `id`, `date`, `modified`, `include`, `title`
`status` string \| 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

GET /kbs/v1/forms/<id>

$ curl https://example.com/wp-json/kbs/v1/forms/<id>

`id`	WP Post ID of the form

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.

Select your rating:

Developer Docs REST API Last updated: 23/08/2023

Published by Cristian Raiber

Posts by Cristian Raiber