List Surveys

Retrieve a paginated list of surveys.

Endpoint

GET /v1/surveys

Authentication

Requires an API key with the surveys:read scope.

Query Parameters

Parameter	Type	Default	Description
page	integer	1	Page number
per_page	integer	15	Items per page (max 100)
search	string	-	Search by survey name
status	string	-	Filter by status: published, draft
sort	string	created_at	Sort field: id, name, created_at, status
order	string	desc	Sort direction: asc or desc

Response

Success (200 OK)

{
  "data": [
    {
      "id": 1,
      "name": "Customer Satisfaction Survey",
      "status": "published",
      "unique_code": "CSS-001",
      "total_pages": 1,
      "apply_to_all_products": false,
      "apply_to_all_experiences": true,
      "responses_count": 156,
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-06-15T10:30:00+00:00"
    },
    {
      "id": 2,
      "name": "Post-Rental Feedback",
      "status": "published",
      "unique_code": "PRF-001",
      "total_pages": 1,
      "apply_to_all_products": true,
      "apply_to_all_experiences": false,
      "responses_count": 89,
      "created_at": "2025-03-01T00:00:00+00:00",
      "updated_at": "2025-06-15T10:30:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 5,
    "total_pages": 1,
    "request_id": "req_abc123",
    "timestamp": "2026-01-15T12:00:00+00:00"
  }
}

Response Fields

Field	Type	Description
id	integer	Unique identifier
name	string	Survey name
status	string	published or draft
unique_code	string	Unique identifier code
total_pages	integer	Number of pages in the survey
apply_to_all_products	boolean	Auto-applied to all products
apply_to_all_experiences	boolean	Auto-applied to all experiences
responses_count	integer	Total number of responses
created_at	string	ISO 8601 datetime
updated_at	string	ISO 8601 datetime

Errors

Status	Code	Description
401	authentication_required	No API key provided
401	invalid_api_key	Invalid API key
403	insufficient_scope	API key lacks surveys:read scope

Example Request

curl -X GET "https://app.equipdash.com/api/v1/surveys?status=published" \
  -H "Authorization: Bearer eqd_live_abc123xyz789..."