List survey rows

Módulo Workforce

GET/surveyssurveys.list

A pulse survey for an audience, anonymous by default, with results only once the minimum number of responses is met. Returns a cursor page of survey rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad knowledge.sop.read.
Alcances de OAuth: knowledge.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

surveys.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de Survey

surveys.list: Survey
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the survey.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
title	string	Sí	Survey title.Restricciones: length 1 to 200
description	string \| null	Sí	What the survey asks about.Restricciones: length 1 to 2000
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	Sí	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid) \| null	Sí	Identifier of the project audience, or the project the row belongs to.
team_id	string (uuid) \| null	Sí	Identifier of the team audience.
role_id	string (uuid) \| null	Sí	Identifier of the org role audience.
group_id	string (uuid) \| null	Sí	Identifier of the group audience, including department groups.
author_membership_id	string (uuid) \| null	Sí	Identifier of the member who wrote the survey.
is_anonymous	boolean	Sí	Whether answers are stored with no respondent.
min_responses	integer	Sí	Responses needed before results show.Restricciones: range 3 to any
survey_state	"Draft" \| "Open" \| "Closed"	Sí	Draft, Open or Closed.
closes_at	string (date-time) \| null	Sí	When responses stop.

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "title": "Load-in pulse",
      "description": "Tell us how the load-in felt.",
      "audience_kind": "Organization",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "is_anonymous": true,
      "min_responses": 5,
      "survey_state": "Draft",
      "closes_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/surveys" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.surveys.listAll()) {
  console.log(row);
}

for row in xos.surveys.list_all():
    print(row)

xos surveys list --all