Surveys

Project forms for structured data collection. Surveys can trigger automations on submission, making them useful for intake forms, onboarding workflows, and status updates. Supports custom fields for form fields.

Attributes

created_at string
Response Parameter `filter`

Timestamp when this survey was created.
creator person
Response

The person who created this survey.
creator_id integer
Parameter `filter`

ID of the person who created this survey.
editable boolean
Parameter `filter`

Whether the current user can edit this survey.
id integer
Parameter `filter` Parameter `sort`

The unique identifier of this survey.
organization organization
Response

The organization this survey belongs to.
project project
Response

The project this survey is associated with.
project_id integer
Request Parameter `filter`

ID of the project this survey is associated with.
public_uuid string
Response

Public UUID used to identify this survey in shareable links.
query string
Parameter `filter`

Text search query applied when filtering surveys.
submission_access string
Response Request Enum

Controls who can submit responses to this survey: nobody, project_members, organization, or public.

Enum Values (4 values)

  • nobody
  • project_members
  • organization
  • public
title string
Response Request Parameter `filter` Parameter `sort`

The title of this survey.
updated_at string
Response

Timestamp when this survey was last updated.
updater person
Response

The person who last updated this survey.

Operations

GET /api/v2/surveys
Get surveys
POST /api/v2/surveys
Create a survey
POST /api/v2/surveys/copy
Copies a survey
DELETE /api/v2/surveys/{id}
Deletes a survey
GET /api/v2/surveys/{id}
Gets a survey
PATCH /api/v2/surveys/{id}
Update a survey