Retrieve Form Fields

get

https://example.com/form_fields/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

section

integer

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

field_type

integer

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

required

boolean

Filter via required boolean value, accepts true or false. Determines whether or not a Form Field is required when submitting a Case Form via the user interface.

disabled

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not a Form Field is enabled to be used by Agents.

hide_by_default

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not a Form Field is initially hidden via the user interface.

related_field

integer

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

is_related_field

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not a Form Field is considered a related field for other Form Fields.

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