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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

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
​
data
object