Get a survey
Workforce module
GET/surveys/{id}surveys.get
A pulse survey for an audience, anonymous by default, with results only once the minimum number of responses is met. Returns one survey with its `ETag`. A survey the caller may not see returns 404.
- Requires the capability knowledge.sop.read.
- OAuth scopes: knowledge.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the survey. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: Survey
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the survey. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| title | string | Yes | Survey title.Constraints: length 1 to 200 |
| description | string | null | Yes | What the survey asks about.Constraints: length 1 to 2000 |
| audience_kind | "Organization" | "Project" | "Team" | "Department" | "Role" | "Group" | Yes | Who the row reaches. Department (a canon department, 1365) is for feed posts only. |
| project_id | string (uuid) | null | Yes | Identifier of the project audience, or the project the row belongs to. |
| team_id | string (uuid) | null | Yes | Identifier of the team audience. |
| role_id | string (uuid) | null | Yes | Identifier of the org role audience. |
| group_id | string (uuid) | null | Yes | Identifier of the group audience, including department groups. |
| author_membership_id | string (uuid) | null | Yes | Identifier of the member who wrote the survey. |
| is_anonymous | boolean | Yes | Whether answers are stored with no respondent. |
| min_responses | integer | Yes | Responses needed before results show.Constraints: range 3 to any |
| survey_state | "Draft" | "Open" | "Closed" | Yes | Draft, Open or Closed. |
| closes_at | string (date-time) | null | Yes | When responses stop. |
{
"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"
}Code samples
curl -X GET "$XOS_BASE_URL/surveys/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.surveys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.surveys.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos surveys get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f