Skip to content

Get a survey

Returns one survey by id, with the same fields as the list endpoint.

HTTP request

GET https://www.asqiro.com/api/v1/surveys/{id}

Any API key in the survey's workspace.

Path parameters

ParameterTypeDescription
idstringThe survey id, as returned by the surveys endpoints.Required

Response body

FieldTypeDescription
idstringUnique survey id.
titlestringSurvey title as shown to respondents.
descriptionstring· nullableSurvey description, or null when none is set.
status"draft" | "published" | "closed"Current lifecycle status.
publishedbooleanWhether the survey is currently accepting responses.
questionCountintegerNumber of questions in the survey.
responseCountintegerTotal responses received, including incomplete ones.
createdAtstring (ISO 8601)When the survey was created.
updatedAtstring (ISO 8601)When the survey was last changed.

Errors

  • unauthorized · 401 · The API key is missing, malformed, deleted, or its creator lost workspace access. Check the Authorization header, then the key itself.
  • forbidden · 403 · The key is valid but lacks the access this call needs - most often a read-only key attempting a write.
  • not_found · 404 · No survey with that id is reachable by this key. A survey in another workspace answers the same way as one that does not exist.
  • plan_upgrade_required · 403 · The workspace owner's plan does not include API access. Upgrading the plan restores it; retrying will not.
  • rate_limited · 429 · Too many requests. The Retry-After response header carries the number of seconds to wait.

Example request

bash
curl "https://www.asqiro.com/api/v1/surveys/s_7t2qk8wvbf31" \
  -H "Authorization: Bearer $ASQIRO_API_KEY"

Returns 200 on success.

Example response
json
{
  "id": "s_7t2qk8wvbf31",
  "title": "Onboarding feedback",
  "description": null,
  "status": "published",
  "published": true,
  "questionCount": 8,
  "responseCount": 142,
  "createdAt": "2026-07-02T09:14:31.220Z",
  "updatedAt": "2026-08-11T16:02:07.884Z"
}