Skip to main content
GET
/
custom-fields
cURL
curl --request GET \
  --url https://api.dock.us/{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

​
Authorization
string
header
required

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

Query Parameters

​
page
integer

Page number

​
limit
integer

Number of results to return

​
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
​
object
enum<string>

Object type

Available options:
workspace,
account,
deal
Example:

"workspace"

Response

List of custom fields

​
data
object