Get a survey question
Módulo Workforce
GET/survey-questions/{id}surveyQuestions.get
A question of a pulse survey, in order. Returns one survey question with its `ETag`. A survey question the caller may not see returns 404.
- Requiere la capacidad knowledge.sop.read.
- Alcances de OAuth: knowledge.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the survey question. |
| 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_]*)*$ |
Respuesta 200: 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. |
{
"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
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/survey-questions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.surveyQuestions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.survey_questions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos survey-questions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f