Get Custom Field / Folder By Id

GEThttps://services.leadconnectorhq.com/custom-fields/{id}
!Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
id
string
required
Body
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

field
object
locationId
string
required

Location Id

Example:
ve9EPM428h8vShlRW1KT
name
string

Field name

Example:
Name
description
string

Description of the field

placeholder
string

Placeholder text for the field

showInForms
boolean
required

Whether the field should be shown in forms

options
array[object]

Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)

key
string
required

Key of the option (Included in Create and Response, excluded in Update)

label
string
required

Value of the option

url
string

URL associated with the option (Optional, valid only for RADIO type)

acceptedFormats
string

Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all

Allowed values:
.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
id
string
required

Unique identifier of the object

objectKey
string
required

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
dataType
string
required

Type of field that you are trying to create

Allowed values:
TEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO
parentId
string
required

ID of the parent folder

Example:
3v34PM428h8vShlRW1KT
fieldKey
string
required

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
allowCustomOption
boolean

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
maxFileLimit
number

Maximum file limit for uploads

Example:
2
dateAdded
string<date-time>
required

Date and time when the object was added

dateUpdated
string<date-time>
required

Date and time when the object was last updated

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request