Menu Close Menu
Menu
  • 0
    • Number of items in cart: 0

      • Your cart is empty.
      • Total: $0.00
      • Checkout
  • Pricing
    • Purchase Options
    • Individual Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Blog

Forms REST API Route

Forms REST API Route

List submission forms via 3rd party applications

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.

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

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: 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

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.

Developer Docs REST API Last updated: 21/01/2021

Published by Cristian Raiber

Posts by Cristian Raiber

Post navigation

Previous

Form Fields REST API Route

Next

Customising Template Files

Contact Details

  • Follow us on Twitter
  • Like us on Facebook
  • Fork us on GitHub

Developer Resources

Plugin Boilerplate

Trello Board

GitHub Repository

Ratings & Satisfaction Docs

  • Configuring Ratings and Satisfaction
  • Advanced Settings

Email Support Docs

  • Plugin Requirements
  • Configuring Email Support
  • Creating New Tickets
  • Replying to Closed Tickets
  • Anonymous Replies in Email Support
  • HTML Emails Tags
  • Email Commands
  • Defining IMAP Flags

KBS REST API Docs

  • Using the REST API
  • Tickets REST API Route
  • Replies REST API Route
  • Articles REST API Route
  • Agents REST API Route
  • Customers REST API Route
  • Companies REST API Route
  • Forms REST API Route
  • Form Fields REST API Route
  • Ticket Categories REST API Route
  • Ticket Departments REST API Route
  • Ticket Source REST API Route

Article Categories

  • Configuration
    • Advanced
    • Getting Started
  • Developer Docs
    • Constants
    • Hooks
  • Extensions
  • FAQs
© 2023 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Privacy Policy
  • Discount Code