Custom fields
Retrieve a list of custom fields
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Custom fields
Retrieve a list of custom fields
Retrieve a list of custom fields
GET
/
custom-fields
curl --request GET \
--url https://api.dock.so:4000/{version}/custom-fields \
--header 'Authorization: Bearer <token>'
{
"data": {
"customFields": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "customField",
"url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
"variableName": "account.name",
"type": "singleCheckbox",
"options": [
{
"index": 1,
"label": "Yes",
"value": "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
Page number
Number of results to return
Select the custom field properties that should be returned
Available options:
name
, variableName
, type
, options.index
, options.label
, options.value
, createdAt
, updatedAt
Object type
Available options:
workspace
, account
, deal
Example:
"workspace"
Response
200
application/json
List of custom fields
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:
customField
Example:
"customField"
URL to the resource
Example:
"https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS"
Variable name of the custom field
Example:
"account.name"
Type of the custom field
Available options:
number
, date
, singleLineText
, multiLineText
, singleCheckbox
, multiCheckboxes
, dropdownSelect
, radioSelect
Example:
"singleCheckbox"
Current page number
Example:
1
Total number of pages
Example:
10
Total number of items
Example:
100
Number of items on the current page
Example:
10
Whether there is a next page
Example:
true
Whether there is a previous page
Example:
false
curl --request GET \
--url https://api.dock.so:4000/{version}/custom-fields \
--header 'Authorization: Bearer <token>'
{
"data": {
"customFields": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "customField",
"url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
"variableName": "account.name",
"type": "singleCheckbox",
"options": [
{
"index": 1,
"label": "Yes",
"value": "true"
}
]
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}