Fields
id String Optional format: "uuid"
Active state
Allowed values: ACTIVE INACTIVE DELETED
created Datetime Optional
Timestamp when document was created.
changed Datetime Optional
Timestamp of when the last change occurred.
createdBy String Optional
Audit identification of who created the document.
changedBy String Optional
Audit identification of who changed the document.
tenantId String Optional
Document tenant id.
companyId String Optional format: "uuid"
Company id connected with the survey.
locationId String Optional format: "uuid"
Location id connected with the survey.
templateId String Optional format: "uuid"
Template id.
Survey type.
Allowed values: TEMPLATE SURVEY TRANSLATION
Survey purpose.
Allowed values: INTERNAL EXTERNAL
Survey display mode.
Allowed values: SCROLL PAGES FORM
description String Optional
Description.
language String Optional
Language.
languages list of optional Strings Optional
Languages.
pages Integer Optional
Pages
nextNumber Integer Optional
Next number for template
performedBy String Optional format: "uuid"
Performed by user.
performedDate Datetime Optional
Survey performed
Survey status.
Allowed values: CREATED IN_PROGRESS COMPLETED
Template status.
Allowed values: DRAFT PUBLISHED PUBLISHED_WITH_DIFFERENCES
totalFields Integer Optional
Total fields.
completedFields Integer Optional
Completed fields.
completedSurveys Integer Optional
Completed surveys.
hideTitle Boolean Optional
Hide title.
submitterInfo Boolean Optional
Submitter info.
enableLeaveExternalReview Boolean Optional
Enable leave external review.
enableRewards Boolean Optional
Enable rewards.
rewardIds list of optional Strings Optional
Reward ids.
interactionTime Double Optional
Interaction time.
dateOfVisit Datetime Optional
Date of visit.
User consents.
Allowed values: DATA_COLLECTION MARKETING
enableMarketingConsent Boolean Optional
Enable marketing consent.
themeId String Optional format: "uuid"
Theme id.
userName String Optional
User name.
userEmail String Optional
User email.
externalId String Optional
External id.
allowAnonymous Boolean Optional
Allow anonymous.
System tag for the survey.
File URLs associated with the survey.
notificationsIds list of optional Strings Optional
Notification ids associated with the survey.
supportTicketId String Optional format: "uuid"
Support ticket id associated with the survey.
publicImageUrls Boolean Optional
Indicates if the file URLs are public.
isPrivate Boolean Optional
Private.
userAccessIds list of optional Strings Optional
User access ids.
