Returns the account's survey master templates. Required scope: r_surveys.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint uses ther_surveysscope, which must be enabled through the Integrations section found within the Settings menu.
Requires a user token whose member has permission to view survey cycles, or an account token together with the member_id query parameter of such a member (the request is then evaluated with that member's permissions). An account token without member_id gets 403 Account tokens need a member_id for this operation. The account must have the Surveys feature enabled.
Only the latest, non-deleted master templates in the survey category are returned. Performance review templates are not included.
Pagination
limit and offset are optional. When both are omitted, every matching template is returned in a single response.
Results
{
"total_count": 1,
"templates": [
{
"id": "b2f0c1de-5a7e-4c1b-9d2a-0f6c3e8a91d4",
"title": "Quarterly Engagement Pulse",
"updated_at": "2025-01-10T09:30:00.000Z",
"version": 2,
"questionnaire": {
"sections": [
{
"id": "2501ee00-0002-51cc-8e1c-6b29548a3d01",
"body": "<p>Your experience</p>",
"questions": [
{
"id": "2501ee00-0003-51cc-8e1c-6b29548a3d01",
"body": "<p>What part of your role gives you the most energy right now?</p>",
"type": "paragraph"
},
{
"id": "2501ee00-0005-51cc-8e1c-6b29548a3d01",
"body": "<p>How would you rate your work-life balance?</p>",
"type": "star_rated",
"metadata": {
"mandatory": true,
"rating_options": {
"1": "Poor",
"2": "Fair",
"3": "Good",
"4": "Very good",
"5": "Excellent"
}
}
}
]
}
]
},
"default": false,
"sample": false,
"disabled": false
}
]
}| key | type | description |
|---|---|---|
| total_count | integer | Number of survey templates in the account |
| templates | array | Array of template objects (see GET /surveys/templates/:id for the template payload) |
Error responses
| Status | Condition |
|---|---|
| 400 | Invalid query parameters (limit < 1 or offset < 0) |
| 401 | Missing or invalid token |
| 403 | Missing r_surveys scope, account token without member_id, the Surveys feature is not enabled for the account, or the user lacks permission to view survey cycles |
Error bodies: 401 / 403 responses are plain text holding the reason (e.g. Required scopes missing: ["r_surveys"]). 404 responses are JSON of the form {"message": "..."}. 400 validation errors are JSON keyed by the offending field, e.g. {"limit": {"code": "number.min", "message": "\"limit\" must be greater than or equal to 1"}}.