Get Custom Field / Folder By Id

GET 
/custom-fields/:id

Get Custom Field / Folder By Id.

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 options2023-02-21

id stringrequired

application/json

Successful response

application/json

Schema

Schema

fieldobject

Example (auto)

{
  "field": {
    "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"
  }
}