SURVEY: Survey
The SURVEY entity represents survey records in DemandFlow.
Default definition. This article describes the default
SURVEY definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches SURVEY.Entity properties
| Property | Value |
|---|---|
| Entity code | SURVEY |
| Display name | Survey |
| Plural | Surveys |
| Level | 520 |
Use cases
General-purpose Survey records.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. | |
status | enum | Valid ids: draft (Draft), active (Active), closed (Closed). | |
recipients | enum | Valid ids: staff (Staff), list (List). | |
emailText | text (multi-line) | Invitation Email Text. | |
pplListId | reference → PPLLIST | People List. |
Attachments and additional panels
- Additional panels:
portalsetup,dashboard.
Relationships
- Lookups:
pplListIdpoints at aPPLLISTrecord. - Related lists:
SURVEYQvia comboKey (format:SUB|SURVEY).
Creating a Survey via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "SURVEY",
"level": 520,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"description": "Example text",
"status": "draft"
}Listing Surveys
GET /v1/entities/SURVEY/SUB