Retrieve Form List Fields

get

https://example.com/form_list_fields/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

parent_field

integer

Filter via Form Field by ID. Must supply integer value, cannot search by Form Field 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.

managed_by_admin

boolean

Filter via managed_by_admin boolean value, accepts true or false. Determines whether or not a Form List Field is only modifiable by Administrators.

required

boolean

Filter via required boolean value, accepts true or false. Determines whether or not a Form List 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 List Field is enabled to be used by Agents.

hide_by_default

boolean

Filter via hide_by_default boolean value, accepts true or false. Determines whether or not Form Section is hidden initially.

Response

200search results matching criteria