Retrieve Form Types

get

https://example.com/form_types/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

form_group

integer

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

agency

integer

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

agent_group

integer

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

allow_copy

boolean

Filter via allow_copy boolean value, accepts true or false. Determines whether or not Forms are able to be copied with this Form Type.

copy_signatures

boolean

Filter via allow_copy boolean value, accepts true or false. Determines whether or not a Form Signature is able to be copied to multiple Forms with this Form Type.

allow_comments

boolean

Filter via allow_comments boolean value, accepts true or false. Determines whether or not Agents are allowed to submit comments on a Form.

show_modifications

boolean

Filter via show_modifications boolean value, accepts true or false. Determines whether or not Agents are allowed to see Form Modifications for this Form Type.

never_show_values

boolean

Filter via never_show_values boolean value, accepts true or false. If set to true, hides all Form Values associated with this Form Type from Agents - eg. for highly-sensitive information.

always_show_values

boolean

Filter via always_show_values boolean value, accepts true or false. If set to true, Form Values associated with this Form Type are always shown to Agents regardless of other permissions.

always_show_updates

boolean

Filter via always_show_updates boolean value, accepts true or false. If set to true, Form Value Modifications associated with this Form Type are always shown to Agents regardless of other permissions.

disabled

boolean

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

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