{"id":9419,"date":"2021-01-12T23:33:00","date_gmt":"2021-01-12T23:33:00","guid":{"rendered":"https:\/\/kb-support.com\/\/?post_type=article&p=9419"},"modified":"2024-10-24T23:48:22","modified_gmt":"2024-10-24T20:48:22","slug":"forms-rest-api-route","status":"publish","type":"article","link":"https:\/\/kb-support.com\/articles\/forms-rest-api-route\/","title":{"rendered":"Forms REST API Route"},"content":{"rendered":"

Authentication #<\/a><\/h3>\n

No authentication is required for this route.<\/p>\n

Schema #<\/a><\/h3>\n

When working with the Forms REST API route the following fields can be expected in any responses.<\/p>\n

<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
id<\/code>
\ninteger<\/em><\/td>\n		Unique identifier for the form
\nRead Only<\/em><\/td>\n<\/tr>\n
date<\/code>
\nstring<\/em><\/td>\n		The date the form was published, in the site’s timezone<\/td>\n<\/tr>\n
date_gmt<\/code>
\nstring<\/em><\/td>\n		The date the form was published, as GMT<\/td>\n<\/tr>\n
modified<\/code>
\nstring<\/em><\/td>\n		The date the form was last modified, in the site’s timezone<\/td>\n<\/tr>\n
modified_gmt<\/code>
\nstring<\/em><\/td>\n		The date the form was last modified, as GMT<\/td>\n<\/tr>\n
status<\/code>
\nstring<\/em><\/td>\n		The named status of the form
\nOne of: publish<\/code>, future<\/code>, draft<\/code>, pending<\/code>, private<\/code><\/em><\/td>\n<\/tr>\n
title<\/code>
\nobject<\/em><\/td>\n		The title of the form<\/td>\n<\/tr>\n
meta<\/code>
\nobject<\/em><\/td>\n		Meta fields<\/td>\n<\/tr>\n
fields<\/code>
\nobject<\/em><\/td>\n		Form fields<\/td>\n<\/tr>\n
links<\/code>
\nobject<\/em><\/td>\n		Links associated with the ticket<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/h3>\n

List Forms\u00a0#<\/a><\/h3>\n

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

Definition #<\/a><\/h4>\n

GET \/kbs\/v1\/forms <\/code><\/p>\n

Example Request #<\/a><\/h4>\n

$ curl https:\/\/example.com\/wp-json\/kbs\/v1\/forms<\/code><\/p>\n

Arguments #<\/a><\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n
page<\/code><\/td>\nCurrent page of the collection
\nDefault: 1<\/code><\/em><\/td>\n<\/tr>\n
per_page<\/code><\/td>\nMaximum number of items to be returned in result set
\nDefault: 10<\/code><\/em><\/td>\n<\/tr>\n
search<\/code><\/td>\nLimit results to those matching a string<\/td>\n<\/tr>\n
exclude<\/code><\/td>\nEnsure result set excludes specific post IDs<\/td>\n<\/tr>\n
include<\/code><\/td>\nLimit result set to specific post IDs<\/td>\n<\/tr>\n
offset<\/code><\/td>\nOffset the result set by a specific number of items<\/td>\n<\/tr>\n
order<\/code><\/td>\nOrder sort attribute ascending or descending
\nDefault: <\/em>desc<\/em>
\n<\/code>One of:\u00a0asc<\/code>,\u00a0<\/span>desc<\/code><\/em><\/td>\n<\/tr>\n
orderby<\/code><\/td>\nSort collection by object attribute
\nDefault: title<\/code><\/em>
\nOne of: id<\/code>,\u00a0<\/span>date<\/code>, modified<\/code><\/span>,\u00a0<\/span>include<\/code>, title<\/code><\/em><\/td>\n<\/tr>\n
status<\/code>
\nstring | array<\/em><\/td>\n		Limit result set to forms assigned one or more statuses
\nDefault: publish<\/code><\/em><\/td>\n<\/tr>\n
slug<\/code><\/td>\nLimit result set to posts with one or more specific slugs<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/h3>\n

Retrieve a Single Form\u00a0#<\/a><\/h3>\n

Definitions #<\/a><\/h4>\n

GET \/kbs\/v1\/forms\/<id><\/code><\/p>\n

Example Request #<\/a><\/h4>\n

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

Arguments #<\/a><\/h4>\n\n\n\n
id<\/code><\/td>\nWP Post ID of the form<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

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.<\/p>\n","protected":false},"author":1452,"featured_media":0,"comment_status":"closed","ping_status":"open","template":"elementor_header_footer","meta":{"_kbs_article_restricted":0,"_kbs_article_views":3189,"_kbs_article_views_2026-05":12,"_kbs_edd_article_customers":0,"_kbs_edd_article_restricted_to_products":[],"footnotes":""},"article_category":[24],"article_tag":[141],"_links":{"self":[{"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/articles\/9419"}],"collection":[{"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/articles"}],"about":[{"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/types\/article"}],"author":[{"embeddable":true,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/users\/1452"}],"replies":[{"embeddable":true,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/comments?post=9419"}],"version-history":[{"count":3,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/articles\/9419\/revisions"}],"predecessor-version":[{"id":21472,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/articles\/9419\/revisions\/21472"}],"wp:attachment":[{"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/media?parent=9419"}],"wp:term":[{"taxonomy":"article_category","embeddable":true,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/article_category?post=9419"},{"taxonomy":"article_tag","embeddable":true,"href":"https:\/\/kb-support.com\/wp-json\/wp\/v2\/article_tag?post=9419"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}