List surveys

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "status": "inspection",
      "programming_target": {
        "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform": "questra",
        "instructions": "<string>",
        "fine_tuning_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "config": {},
        "initial_push_succeeded": true,
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "list_summary": {
        "kind": "waiting_questionnaire",
        "programming": {
          "run_id": "<string>",
          "status": "pending",
          "waiting_on_target_selection": true,
          "started_at": "2023-11-07T05:31:56Z",
          "completed_at": "2023-11-07T05:31:56Z",
          "target_wait_ms": 1,
          "target_wait_started_at": "2023-11-07T05:31:56Z"
        },
        "migrated_from": {
          "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 123,
    "offset": 1
  }
}

{
  "error": "validation_error",
  "message": "<string>",
  "details": "<unknown>"
}

GET

surveys

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "status": "inspection",
      "programming_target": {
        "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform": "questra",
        "instructions": "<string>",
        "fine_tuning_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "config": {},
        "initial_push_succeeded": true,
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "list_summary": {
        "kind": "waiting_questionnaire",
        "programming": {
          "run_id": "<string>",
          "status": "pending",
          "waiting_on_target_selection": true,
          "started_at": "2023-11-07T05:31:56Z",
          "completed_at": "2023-11-07T05:31:56Z",
          "target_wait_ms": 1,
          "target_wait_started_at": "2023-11-07T05:31:56Z"
        },
        "migrated_from": {
          "survey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 123,
    "offset": 1
  }
}

{
  "error": "validation_error",
  "message": "<string>",
  "details": "<unknown>"
}

Query Parameters

limit

integer

Page size (default 25, max 100).

Required range: 1 <= x <= 100

offset

integer | null

Rows to skip (default 0).

Required range: x >= 0

string

Case-insensitive search across name, slug, and description.

sort_by

enum<string>

Sort column (default updated_at).

Available options:

name,

created_at,

updated_at

sort_order

enum<string>

Sort direction (default desc).

Available options:

asc,

desc

status

Lifecycle statuses to include (OR). Repeat the param or comma-separate. Omit for all.

Response

Paginated survey list

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

Surveys

Workflows

API keys

Integrations

Webhooks

Settings

Meta

Query Parameters

Response