Get Custom Fields By Object Key

GET 
/custom-fields/object-key/:objectKey

Get Custom Fields By Object Key.

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-07-28

objectKey stringrequired

key of the Object. Must include "custom_objects." prefix for custom objects. Available on the Custom Objects details Page under settings

locationId stringrequired

Location Id

application/json

Successful response

application/json

Schema

Schema

fieldsobject[]

Custom Fields for the object.

foldersobject[]

Custom field folders for the object.

Example (auto)

{
  "fields": [
    {
      "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"
    }
  ],
  "folders": [
    {
      "id": "661c06b4ffde146bdb469442",
      "objectKey": "custom_object.pet",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "General"
    }
  ]
}