Get Survey

Retrieve a single survey by ID, including all fields and assignments.

Endpoint

GET /v1/surveys/{id}

Path Parameters

Parameter	Type	Description
id	integer	Survey ID

Authentication

Requires an API key with the surveys:read scope.

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,
    "fields": [
      {
        "id": 10,
        "field_type": "npsRating",
        "label": "How likely are you to recommend us to a friend?",
        "placeholder": null,
        "is_required": true,
        "page_number": 1,
        "position": 1,
        "options": null
      },
      {
        "id": 11,
        "field_type": "starRating",
        "label": "How would you rate the quality of our equipment?",
        "placeholder": null,
        "is_required": true,
        "page_number": 1,
        "position": 2,
        "options": null
      },
      {
        "id": 12,
        "field_type": "singleChoice",
        "label": "How did you hear about us?",
        "placeholder": null,
        "is_required": false,
        "page_number": 1,
        "position": 3,
        "options": ["Google", "Friend referral", "Social media", "Other"]
      },
      {
        "id": 13,
        "field_type": "longText",
        "label": "Any additional comments or suggestions?",
        "placeholder": "Share your thoughts...",
        "is_required": false,
        "page_number": 1,
        "position": 4,
        "options": null
      }
    ],
    "assigned_products": [],
    "assigned_experiences": [
      {
        "id": 5,
        "type": "Experience"
      },
      {
        "id": 8,
        "type": "Experience"
      }
    ],
    "responses_count": 156,
    "created_at": "2025-01-01T00:00:00+00:00",
    "updated_at": "2025-06-15T10:30:00+00:00"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-01-15T12:00:00+00:00"
  }
}

Response Fields

Survey Object

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
apply_to_all_products	boolean	Auto-applied to all products
apply_to_all_experiences	boolean	Auto-applied to all experiences
fields	array	Survey field definitions
assigned_products	array	Products this survey is assigned to
assigned_experiences	array	Experiences this survey is assigned to
responses_count	integer	Total number of responses
created_at	string	ISO 8601 datetime
updated_at	string	ISO 8601 datetime

Field Object

Field	Type	Description
id	integer	Field ID (use for submitting responses)
field_type	string	Type of field (see below)
label	string	Question/label text
placeholder	string	Placeholder text
is_required	boolean	Whether field is required
page_number	integer	Page this field appears on
position	integer	Order position on the page
options	array	Options for choice fields

Field Types

Type	Description	Expected Value
npsRating	Net Promoter Score	Integer 0-10
starRating	Star rating	Integer 1-5
csat	Customer Satisfaction	Integer 1-5
ces	Customer Effort Score	Integer 1-7
likertScale	Likert agreement scale	Integer 1-5
shortText	Single line text	String
longText	Multi-line text	String
singleChoice	Single selection	String (option value)
multipleChoice	Multiple selection	Array of strings

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
403	forbidden	Survey belongs to another supplier
404	not_found	Survey not found

Example Request

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