Templates
Retrieve a template
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Templates
Retrieve a template
Retrieve a template by ID
GET
/
templates
/
{id}
curl --request GET \
--url https://api.dock.so:4000/{version}/templates/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"template": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "template",
"url": "https://api.dock.us/v1/templates/RiHO4e0Ju3DS",
"name": "Sales Lead",
"types": [
"sales"
],
"title": "Customer Onboarding",
"keyDatesEnabled": true,
"slackChannelEnabled": true,
"messagesEnabled": true,
"stagesEnabled": true
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier
Example:
"RiHO4e0Ju3DS"
Query Parameters
Select the template properties that should be returned
Available options:
name
, types
, title
, keyDatesEnabled
, slackChannelEnabled
, messagesEnabled
, stagesEnabled
Response
200
application/json
Retrieve a template by ID
Id of the object
Example:
"RiHO4e0Ju3DS"
Last updated date
Example:
"2021-01-01T00:00:00.000Z"
Created at date
Example:
"2021-01-01T00:00:00.000Z"
Type of the object
Available options:
template
Example:
"template"
URL to the resource
Example:
"https://api.dock.us/v1/templates/RiHO4e0Ju3DS"
Name of the template
Example:
"Sales Lead"
Types of the template
Available options:
sales
, implementation
, renewal
, portal
, project
, internal
Title of the template
Example:
"Customer Onboarding"
Whether key dates are enabled
Example:
true
Whether a slack channel is enabled
Example:
true
Whether messages are enabled
Example:
true
Whether stages are enabled
Example:
true
curl --request GET \
--url https://api.dock.so:4000/{version}/templates/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"template": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "template",
"url": "https://api.dock.us/v1/templates/RiHO4e0Ju3DS",
"name": "Sales Lead",
"types": [
"sales"
],
"title": "Customer Onboarding",
"keyDatesEnabled": true,
"slackChannelEnabled": true,
"messagesEnabled": true,
"stagesEnabled": true
}
}
}