List Survey Templates
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', 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"
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 \
--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": 1,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": [
{ "key": "start_date", "enabled": true, "required": true, "order": 1 },
{ "key": "name", "enabled": true, "required": false, "order": 2 },
{ "key": "hours_worked_per_day", "enabled": true, "required": true, "default_value": 8, "order": 3 },
{ "key": "telecommute", "enabled": true, "required": true, "order": 4 },
{ "key": "weekly_travels", "enabled": true, "required": true, "order": 5 },
{ "key": "weekly_telecommuting", "enabled": true, "required": true, "order": 6 },
{ "key": "daily_trips", "enabled": true, "required": true, "order": 7 },
{ "key": "total_km", "enabled": true, "required": true, "order": 8 },
{ "key": "transport", "enabled": true, "required": true, "order": 9 },
{ "key": "fuel_type", "enabled": true, "required": true, "order": 10 },
{ "key": "carpooling", "enabled": true, "required": true, "order": 11 },
{ "key": "commuting_address", "enabled": true, "required": false, "order": 12 }
],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
List Survey Templates
Retrieve all survey templates for your organization
GET
/
v1
/
employee-survey-templates
List Survey Templates
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', 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"
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 \
--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": 1,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": [
{ "key": "start_date", "enabled": true, "required": true, "order": 1 },
{ "key": "name", "enabled": true, "required": false, "order": 2 },
{ "key": "hours_worked_per_day", "enabled": true, "required": true, "default_value": 8, "order": 3 },
{ "key": "telecommute", "enabled": true, "required": true, "order": 4 },
{ "key": "weekly_travels", "enabled": true, "required": true, "order": 5 },
{ "key": "weekly_telecommuting", "enabled": true, "required": true, "order": 6 },
{ "key": "daily_trips", "enabled": true, "required": true, "order": 7 },
{ "key": "total_km", "enabled": true, "required": true, "order": 8 },
{ "key": "transport", "enabled": true, "required": true, "order": 9 },
{ "key": "fuel_type", "enabled": true, "required": true, "order": 10 },
{ "key": "carpooling", "enabled": true, "required": true, "order": 11 },
{ "key": "commuting_address", "enabled": true, "required": false, "order": 12 }
],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
List Survey Templates
Returns all active survey templates for the authenticated organization, ordered by creation date (newest first).Request
Headers
string
required
Your API key for authentication
string
required
Your organization UUID
Response
Returns an array of template objects.[
{
"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": 1,
"config": {
"version": 1,
"work_mode": "hybrid",
"steps": [
{ "key": "start_date", "enabled": true, "required": true, "order": 1 },
{ "key": "name", "enabled": true, "required": false, "order": 2 },
{ "key": "hours_worked_per_day", "enabled": true, "required": true, "default_value": 8, "order": 3 },
{ "key": "telecommute", "enabled": true, "required": true, "order": 4 },
{ "key": "weekly_travels", "enabled": true, "required": true, "order": 5 },
{ "key": "weekly_telecommuting", "enabled": true, "required": true, "order": 6 },
{ "key": "daily_trips", "enabled": true, "required": true, "order": 7 },
{ "key": "total_km", "enabled": true, "required": true, "order": 8 },
{ "key": "transport", "enabled": true, "required": true, "order": 9 },
{ "key": "fuel_type", "enabled": true, "required": true, "order": 10 },
{ "key": "carpooling", "enabled": true, "required": true, "order": 11 },
{ "key": "commuting_address", "enabled": true, "required": false, "order": 12 }
],
"custom_fields": [],
"branding": {}
},
"created_by": "user-uuid",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
Was this page helpful?
⌘I