List survey question rows

Módulo Workforce

GET/survey-questionssurveyQuestions.list

A question of a pulse survey, in order. Returns a cursor page of survey question 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

surveyQuestions.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 SurveyQuestion

surveyQuestions.list: SurveyQuestion
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the survey question.
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.
survey_id	string (uuid)	Sí	Identifier of the survey.
position	integer	Sí	Order, from 1.Restricciones: range 1 to any
prompt	string	Sí	Question text.Restricciones: length 1 to 500
question_kind	"Scale" \| "Choice" \| "Text"	Sí	Question kind.
choices	array of string \| null	Sí	Options of a Choice question.
scale_max	integer \| null	Sí	Top of a Scale question: 5 or 10.Restricciones: range 5 to any
is_required	boolean	Sí	Whether a response must answer it.

{
  "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",
      "survey_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "position": 1,
      "prompt": "How safe did the load-in feel?",
      "question_kind": "Scale",
      "choices": [
        "Morning",
        "Night"
      ],
      "scale_max": 5,
      "is_required": true
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos survey-questions list --all