Skip to content

Surveys

Surveys sent out to vendors or staff: sending, reminders, answers and analytics.

Loading a list with search, filters and paging? Use Surveys — list screen: the filters go in the request body.

Base path
/surveys

Endpoints

25 endpoints

Method

Standard Operations

7
  • GET /surveys List surveys (with search, filters and paging).
  • POST /surveys Create a new survey.
  • PATCH /surveys/bulk Update several surveys at once.
  • GET /surveys/{id} Open a single survey.
  • PUT /surveys/{id} Replace a survey's details in full.
  • PATCH /surveys/{id} Edit a survey.
  • DELETE /surveys/{id} Delete a survey.

Additional Operations

18
  • POST /surveys/{id}/send Send a survey out to its recipients.
  • POST /surveys/{id}/createPreviewInvitations Create preview invitations so a survey can be tested before sending.
  • POST /surveys/{id}/sendReminder Send a reminder to people who haven't answered.
  • POST /surveys/owner Add an owner to a survey.
  • DELETE /surveys/{surveyId}/owner/{userId} Remove an owner from a survey.
  • GET /surveys/{surveyId}/analytics Show results and statistics for a survey.
  • GET /surveys/{surveyId}/analytics/csv Download survey statistics as a spreadsheet.
  • GET /surveys/{surveyId}/invitations List who has been invited to a survey.
  • DELETE /surveys/{surveyId}/invitations/{invitationId} Withdraw a survey invitation.
  • GET /surveys/{surveyId}/answers List answers submitted to a survey.
  • POST /surveys/{surveyId}/clone Copy a survey.
  • GET /surveys/{surveyId}/files List documents attached to a survey.
  • POST /surveys/{surveyId}/files Attach a document to a survey.
  • DELETE /surveys/{surveyId}/file/{fileId} Remove a document from a survey.
  • GET /surveys/answers List survey answers across surveys.
  • POST /surveys/{surveyId}/invitations/export Download the invitation list as a spreadsheet.
  • POST /surveys/{surveyId}/answers/export Download the answers as a spreadsheet.
  • GET /surveys/field-lists/{surveyId} List the fields that can be used in a survey.