Skip to content

support_survey_list

List this product’s surveys, newest first, with pagination.

Tool

support_survey_list

List this product’s surveys, newest first, with pagination.

List this product’s surveys, newest first, with pagination. Supply status to return only draft, published or archived surveys; omit status to include all three states.

Behavior

HTTP
GET /support/surveys

Arguments

Name
Type
Required
Description
limit
integer
—
Page size, 1..100 (default 25)
offset
integer
—
Number of surveys to skip
status
string
—
Only surveys in this lifecycle state

Response

Field
Type
Always
Description
limit
integer
•
Page size that was applied
offset
integer
•
Offset that was applied
surveys
array
•
The requested page of surveys, newest first

Try it

List this product’s surveys, newest first, with pagination.

When to use

List this product’s surveys, newest first, with pagination. Supply status to return only draft, published or archived surveys; omit status to include all three states.

Example

Ask your agent something like this:

List this product’s surveys, newest first, with pagination.

The agent will invoke support_survey_list with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select