Retrieve Form Options

get

https://example.com/form_options/

Returns a list of Form Options applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

field

integer

Filter via Form Field by ID. Must supply integer value, cannot search by Form Field name or other field information.

default

boolean

Filter via default boolean value, accepts true or false. Determines whether or not a Form Option is the default choice for its respective Field.

hide_fields

string

Filter via Form Field by ID - is an array of Form Fields to be hidden if selected.

show_fields

string

Filter via Form Field by ID - is an array of Form Fields to be shown if selected.

hide_sections

string

Filter via Form Section by ID - is an array of Form Sections to be hidden if selected.

show_sections

string

Filter via Form Section by ID - is an array of Form Sections to be shown if selected.

hide_templates

string

Filter via Form Template by ID - is an array of Form Templates to be hidden if selected.

show_templates

string

Filter via Form Template by ID - is an array of Form Templates to be shown if selected.

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria