Custom fields
Retrieve a custom field
API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Custom fields
Retrieve a custom field
Retrieve a custom field by ID
GET
/
custom-fields
/
{id}
curl --request GET \
--url https://api.dock.so:4000/{version}/custom-fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"customField": {
"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"
}
]
}
}
}
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 custom field properties that should be returned
Available options:
name
, variableName
, type
, options.index
, options.label
, options.value
, createdAt
, updatedAt
Response
200
application/json
Retrieve a custom field 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:
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"
curl --request GET \
--url https://api.dock.so:4000/{version}/custom-fields/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"customField": {
"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"
}
]
}
}
}