Forms
View as MarkdownForms define the fields and sections used to collect applications and registrations.
Forms define the fields and sections used to collect applications and registrations.
Attributes
idinteger- Identifier assigned by the API.
namestring- Internal form name, up to 100 characters. Supply a non-empty value when changing it.
titlestring or null- Title shown to people filling in the form, up to 140 characters.
common_fieldsmap or array- Shared field configuration.
user_fieldsmap- Form definition. Put custom sections and their field definitions in form.sections. Keep existing element IDs when editing them.
editableinteger- 1 for an editable form, 0 for a managed read-only form.
is_in_useboolean- Whether a public registration flow currently uses the form.
cloned_from_idinteger or null- Source form ID for a copy.
tscinteger- Creation time as a Unix timestamp in seconds.
tsuinteger- Last update time as a Unix timestamp in seconds.
/api/v1/formsLists form records in the workspace.
Permissions
Send your API key in X-API-Key. Required permissions are Forms → Read.
Query parameters
qstring- Search by form name.
lengthinteger- Number of records to return.
startinteger- Zero-based offset.
drawstring- Optional request marker echoed in the response.
sortstring- Sort by id, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring- Direction for unprefixed sort fields. Use asc or desc.
Returns
Returns records in data, the counts before and after text search, and the echoed draw marker.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
/api/v1/forms/{id}Returns one form by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Forms → Read.
Path parameters
idintegerRequired- ID of the form.
Returns
The form is returned in data.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
/api/v1/forms/{id}Updates a form by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Forms → Write.
Path parameters
idintegerRequired- ID of the form.
Body parameters
namestring- Internal form name, up to 100 characters. Supply a non-empty value when changing it.
titlestring or null- Title shown to people filling in the form, up to 140 characters.
common_fieldsmap or array- Shared field configuration.
user_fieldsmap- Form definition. Put custom sections and their field definitions in form.sections. Keep existing element IDs when editing them.
Managed forms are read-only. An unchanged request returns the message key entities.form.messages.no_changes.
Returns
Returns a successful update response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The fields or form definition could not be saved.
/api/v1/forms/{id}/api/v1/forms/{id}/deleteRemoves an editable form.
Permissions
Send your API key in X-API-Key. Required permissions are Forms → Write.
Path parameters
idintegerRequired- ID of the form.
Returns
Returns a successful removal response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The form could not be removed.