key of the Object. Must include "custom_objects." prefix for custom objects. Available on the Custom Objects details Page under settings
Example:custom_objects.pet
Query Parameters
locationIdstringrequired
Example:Location Id
Response
application/json
Successful response
fieldsobject[]
Custom Fields for the object.
fields[].locationIdstringrequired
Location Id
Example:ve9EPM428h8vShlRW1KT
fields[].namestring
Field name
Example:Name
fields[].descriptionstring
Description of the field
fields[].placeholderstring
Placeholder text for the field
fields[].showInFormsbooleanrequired
Whether the field should be shown in forms
fields[].optionsobject[]
Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
fields[].options[].keystringrequired
Key of the option (Included in Create and Response, excluded in Update)
fields[].options[].labelstringrequired
Value of the option
fields[].options[].urlstring
URL associated with the option (Optional, valid only for RADIO type)
fields[].acceptedFormatsstring
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Available options.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
fields[].idstringrequired
Unique identifier of the object
fields[].objectKeystringrequired
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Example:custom_object.pet
fields[].dataTypestringrequired
Type of field that you are trying to create
Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO
fields[].parentIdstringrequired
ID of the parent folder
Example:3v34PM428h8vShlRW1KT
fields[].fieldKeystringrequired
Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
Example:custom_object.pet.name
fields[].allowCustomOptionboolean
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Example:true
fields[].maxFileLimitnumber
Maximum file limit for uploads
Example:2
fields[].dateAddedstring<date-time>required
Date and time when the object was added
fields[].dateUpdatedstring<date-time>required
Date and time when the object was last updated
foldersobject[]
Custom Fields folder for the object.
folders[].locationIdstringrequired
Location Id
Example:ve9EPM428h8vShlRW1KT
folders[].namestring
Field name
Example:Name
folders[].descriptionstring
Description of the field
folders[].placeholderstring
Placeholder text for the field
folders[].showInFormsbooleanrequired
Whether the field should be shown in forms
folders[].optionsobject[]
Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
folders[].options[].keystringrequired
Key of the option (Included in Create and Response, excluded in Update)
folders[].options[].labelstringrequired
Value of the option
folders[].options[].urlstring
URL associated with the option (Optional, valid only for RADIO type)
folders[].acceptedFormatsstring
Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Available options.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
folders[].idstringrequired
Unique identifier of the object
folders[].objectKeystringrequired
The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
Example:custom_object.pet
folders[].dataTypestringrequired
Type of field that you are trying to create
Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO
folders[].parentIdstringrequired
ID of the parent folder
Example:3v34PM428h8vShlRW1KT
folders[].fieldKeystringrequired
Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.
Example:custom_object.pet.name
folders[].allowCustomOptionboolean
Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.