Deskhero Developer Hub
Back to deskhero.com
Forms

Get one

Returns the full definition of one form, including the modules and logics that the listing leaves out. A form the caller has no group access to is reported as not found rather than as forbidden.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/forms/{id}
Authorisation
Minimum role: USER

Request arguments

Name Type Source
idInt32
Request body example

Response

Status
200 (OK)
Type
DTO_form
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_form
NameTypeReadOnlyDescription
group_accessDTO_group_access[]Groups that may read or edit the form, where at least one entry with EDIT permission is required
sys_tagsDTO_reference[]Label can be used on POST/PUT to create new tags
collect_to_listDTO_referenceCustom list that submissions are stored in, required when collect_type is LIST and rejected when collect_type is TICKET
collect_to_groupDTO_referenceGroup that submitted tickets are created in, required when collect_type is TICKET and rejected when collect_type is LIST
modulesDTO_form_module[]Ordered building blocks of the form, such as headers, information texts and fields, where the same field can only be used once per form
logicsDTO_form_logic[]Conditional rules that show or hide fields, or forward to another field or form, depending on the answers given
languageDTO_referenceLanguage used for the built in texts of the externally rendered form, and it must reference one of the platform languages
created_byDTO_reference_userReadOnlyCreated by
last_updated_byDTO_reference_userReadOnlyLast updated by
idInt32ReadOnlyLeave empty on input
highest_group_permissionENUM group_permissionReadOnlyCurrent users highest group permission
nameStringDisplay name of the form, between 2 and 30 characters
unique_keyStringLowercase url safe key used to load the form externally, between 2 and 30 characters, unique within the workspace and built from name when left empty
privacyENUM privacyPUBLIC lets the form be loaded and submitted without authentication, while PRIVATE keeps it inside the workspace
collect_typeENUM form_collect_typeDecides whether a submission becomes a ticket (TICKET) or a row in a list (LIST)
display_typeENUM form_display_typeLayout the client renders the form with, and it is required since the server rejects a form where display_type is left unset
submit_textStringLabel of the submit button, required on create and update
ticket_subjectStringSubject given to tickets that are created from this form, so it only applies when collect_type is TICKET
primary_colorStringMain color of the embedded form, given as six hexadecimal digits with an optional leading number sign
background_colorStringBackground color of the embedded form in the same format as primary_color, and the client derives the accent tones from the two colors
ai_chat_bot_enabledBoolean (nullable)When true, the embedded form starts as an AI chat-bot answering from approved public FAQs. Enabling requires at least 100 approved FAQ items. Nullable so clients that omit the property on update leave the stored value unchanged.
createdDateTimeReadOnlySet by the server in UTC when the form is first stored
last_updatedDateTimeReadOnlySet by the server in UTC every time the form is changed
DTO_group_access
NameTypeReadOnlyDescription
permissionENUM group_permissionPermission
idInt32Id
labelObjectReadOnlyLabel
DTO_reference
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectReadOnlyName/Label from referenced object.
DTO_form_module
NameTypeReadOnlyDescription
module_fieldDTO_form_module_fieldModule field
typeENUM form_module_typeType
text_primaryStringText primary
text_secondaryStringText secondary
enabledBooleanEnabled
DTO_form_module_field
NameTypeReadOnlyDescription
idInt32Id
labelStringLabel
requiredBooleanRequired
DTO_form_logic
NameTypeReadOnlyDescription
triggersDTO_form_logic_trigger[]Triggers
actionDTO_form_logic_actionAction
logic_operatorENUM form_logic_operatorLogic operator
DTO_form_logic_trigger
NameTypeReadOnlyDescription
module_fieldDTO_referenceModule field
field_valuesDTO_reference[]Field values
DTO_form_logic_action
NameTypeReadOnlyDescription
forward_to_module_fieldDTO_referenceForward to module field
forward_to_formDTO_referenceForward to form
hide_module_fieldsDTO_reference[]Hide module fields
show_module_fieldsDTO_reference[]Show module fields
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
idInt32Id
labelObjectReadOnlyLabel
ENUM group_permission
ValueNameDescription
0UNKNOWNUNKNOWN
1READRead only
2EDITEdit
3FULLFull
ENUM form_module_type
ValueNameDescription
0UNKNOWNUNKNOWN
1HEADERHEADER
2INFORMATIONINFORMATION
3FIELDFIELD
4LINE_SEPARATORLINE_SEPARATOR
5PAGE_SEPARATORPAGE_SEPARATOR
6SUBMIT_MESSAGESUBMIT_MESSAGE
ENUM form_logic_operator
ValueNameDescription
0UNKNOWNUNKNOWN
1ANDAND
2OROR
ENUM privacy
ValueNameDescription
0UNKNOWNUNKNOWN
1PRIVATEPRIVATE
2PUBLICPUBLIC
ENUM form_collect_type
ValueNameDescription
0UNKNOWNUNKNOWN
1TICKETTICKET
2LISTLIST
ENUM form_display_type
ValueNameDescription
0UNKNOWNUNKNOWN
1CLASSICCLASSIC
2CARDCARD

Generated Aug 4, 2026 18:37