Get Survey Template
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/employee-survey-templates/{template_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/employee-survey-templates/{template_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/employee-survey-templates/{template_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"name": "Standard Commuting Survey",
"description": "Default template for employee commuting surveys",
"is_default": true,
"status": "active",
"version": 3,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": ["..."],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-07-10T14:20:00Z"
}
{
"detail": "Template doesn't belong to organization",
"code": "FORBIDDEN"
}
{
"detail": "EmployeeSurveyTemplate with id=... not found",
"code": "NOT_FOUND"
}
Get Survey Template
Retrieve a specific survey template by ID
GET
/
v1
/
employee-survey-templates
/
{template_id}
Get Survey Template
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/employee-survey-templates/{template_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/employee-survey-templates/{template_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/employee-survey-templates/{template_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"name": "Standard Commuting Survey",
"description": "Default template for employee commuting surveys",
"is_default": true,
"status": "active",
"version": 3,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": ["..."],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-07-10T14:20:00Z"
}
{
"detail": "Template doesn't belong to organization",
"code": "FORBIDDEN"
}
{
"detail": "EmployeeSurveyTemplate with id=... not found",
"code": "NOT_FOUND"
}
Get Survey Template
Returns a single survey template by its ID. The template must belong to the authenticated organization.Request
Headers
string
required
Your API key for authentication
string
required
Your organization UUID
Path Parameters
string
required
The UUID of the survey templateExample:
550e8400-e29b-41d4-a716-446655440000Response
Returns the template object.{
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"name": "Standard Commuting Survey",
"description": "Default template for employee commuting surveys",
"is_default": true,
"status": "active",
"version": 3,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": ["..."],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-07-10T14:20:00Z"
}
{
"detail": "Template doesn't belong to organization",
"code": "FORBIDDEN"
}
{
"detail": "EmployeeSurveyTemplate with id=... not found",
"code": "NOT_FOUND"
}
Was this page helpful?
⌘I