Form Definitions

Get the list of all form definitions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Form definitions are the templates that forms are made from: they list the fields a form has. This endpoint returns each definition's reference and name.

Add entity (e.g. ?entity=contact) to only list definitions enabled for that type of record, is_active=true or false to filter by status, or include_trash=true to include definitions in the trash.

Attributes

Attribute NameTypeDescriptionAttributes
selfreferenceURL of the Form DefinitionRead-only
Non-null
namestringThe name of the form definitionRead-only
Non-null
Query Params
boolean

Set to true to include form definitions that are in the trash.

string
enum

Only return definitions enabled for this type of record

boolean

true for only active definitions, false for only inactive ones

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json