API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a list of templates
Retrieve a list of templates
curl --request GET \
--url https://api.dock.so:4000/{version}/templates \
--header 'Authorization: Bearer <token>'
{
"data": {
"templates": [
{
"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
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select the template properties that should be returned
name
, types
, title
, keyDatesEnabled
, slackChannelEnabled
, messagesEnabled
, stagesEnabled
Page number
Number of results to return
Response
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
template
"template"
URL to the resource
"https://api.dock.us/v1/templates/RiHO4e0Ju3DS"
Name of the template
"Sales Lead"
Types of the template
sales
, implementation
, renewal
, portal
, project
, internal
Title of the template
"Customer Onboarding"
Whether key dates are enabled
true
Whether a slack channel is enabled
true
Whether messages are enabled
true
Whether stages are enabled
true
Current page number
1
Total number of pages
10
Total number of items
100
Number of items on the current page
10
Whether there is a next page
true
Whether there is a previous page
false
curl --request GET \
--url https://api.dock.so:4000/{version}/templates \
--header 'Authorization: Bearer <token>'
{
"data": {
"templates": [
{
"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
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}