Get Custom Field / Folder By Id

GET 
/custom-fields/:id

Get Custom Field / Folder By Id.

info

Supports Custom Objects, Company (Business), and Project Management tasks (objectKey: "task", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.

Request

Version stringrequired

API Version

Available options2021-04-15

id stringrequired

Unique identifier of the custom field or folder

application/json

Successful response

application/json

Schema

Schema

fieldobject

The custom field or folder matching the requested id

Example (auto)

{
  "field": {
    "id": "661c06b4ffde146bdb469442",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "name": "Pet Name",
    "fieldKey": "custom_object.pet.name",
    "objectKey": "custom_object.pet",
    "dataType": "TEXT",
    "parentId": "3v34PM428h8vShlRW1KT",
    "showInForms": true,
    "dateAdded": "2025-01-02T09:35:39.032Z",
    "dateUpdated": "2025-01-02T09:35:39.032Z"
  }
}