Get Custom Fields By Object Key

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

Get Custom Fields By Object Key

info

Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.

Request

Version stringrequired

API Version

Available optionsv3

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

application/json

Successful response

application/json

Schema

Schema

fieldsobject[]

Custom Fields for the object.

foldersobject[]

Custom Fields folder for the object.

Example (auto)

{
  "fields": [
    {
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Name",
      "description": "string",
      "placeholder": "string",
      "showInForms": true,
      "options": [
        {
          "key": "string",
          "label": "string",
          "url": "string"
        }
      ],
      "acceptedFormats": ".pdf",
      "id": "string",
      "objectKey": "custom_object.pet",
      "dataType": "TEXT",
      "parentId": "3v34PM428h8vShlRW1KT",
      "fieldKey": "custom_object.pet.name",
      "allowCustomOption": true,
      "maxFileLimit": 2,
      "dateAdded": "2024-07-29T15:51:28.071Z",
      "dateUpdated": "2024-07-29T15:51:28.071Z"
    }
  ],
  "folders": [
    {
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Name",
      "description": "string",
      "placeholder": "string",
      "showInForms": true,
      "options": [
        {
          "key": "string",
          "label": "string",
          "url": "string"
        }
      ],
      "acceptedFormats": ".pdf",
      "id": "string",
      "objectKey": "custom_object.pet",
      "dataType": "TEXT",
      "parentId": "3v34PM428h8vShlRW1KT",
      "fieldKey": "custom_object.pet.name",
      "allowCustomOption": true,
      "maxFileLimit": 2,
      "dateAdded": "2024-07-29T15:51:28.071Z",
      "dateUpdated": "2024-07-29T15:51:28.071Z"
    }
  ]
}