Get Custom Fields By Object Key

fields

object[]

Custom Fields for the object.

Show cada item

locationId

string

default:"ve9EPM428h8vShlRW1KT"

required

Account Id

name

string

default:"Name"

Field 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

object[]

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

Show cada item

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 Posibles valores: ‘.pdf’, ‘.docx’, ‘.doc’, ‘.jpg’, ‘.jpeg’, ‘.png’, ‘.gif’, ‘.csv’, ‘.xlsx’, ‘.xls’, ‘all’

string

required

Unique identifier of the object

objectKey

string

default:"custom_object.pet"

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.

dataType

string

required

Type of field that you are trying to create Posibles valores: ‘TEXT’, ‘LARGE_TEXT’, ‘NUMERICAL’, ‘PHONE’, ‘MONETORY’, ‘CHECKBOX’, ‘SINGLE_OPTIONS’, ‘MULTIPLE_OPTIONS’, ‘DATE’, ‘TEXTBOX_LIST’, ‘FILE_UPLOAD’, ‘RADIO’

parentId

string

default:"3v34PM428h8vShlRW1KT"

required

ID of the parent folder

fieldKey

string

default:"custom_object.pet.name"

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.

allowCustomOption

boolean

default:"True"

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.

maxFileLimit

number

default:"2"

Maximum file limit for uploads

dateAdded

string

required

Date and time when the object was added

dateUpdated

string

required

Date and time when the object was last updated

folders

object[]

Custom Fields folder for the object.

Show cada item

locationId

string

default:"ve9EPM428h8vShlRW1KT"

required

Account Id

name

string

default:"Name"

Field 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

object[]

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

Show cada item

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

required

Unique identifier of the object

objectKey

string

default:"custom_object.pet"

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.

dataType

string

required

parentId

string

default:"3v34PM428h8vShlRW1KT"

required

ID of the parent folder

fieldKey

string

default:"custom_object.pet.name"

required

allowCustomOption

boolean

default:"True"

maxFileLimit

number

default:"2"

Maximum file limit for uploads

dateAdded

string

required

Date and time when the object was added

dateUpdated

string

required

Date and time when the object was last updated

{
  "fields": [
    {
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Name",
      "description": "string",
      "placeholder": "string",
      "showInForms": true,
      "options": [
        {}
      ],
      "acceptedFormats": ".pdf",
      "id": "string",
      "objectKey": "custom_object.pet",
      "dataType": "TEXT",
      "parentId": "3v34PM428h8vShlRW1KT",
      "fieldKey": "custom_object.pet.name",
      "allowCustomOption": true,
      "maxFileLimit": 2,
      "dateAdded": "2024-01-15T10:30:00Z",
      "dateUpdated": "2024-01-15T10:30:00Z"
    }
  ],
  "folders": [
    {
      "locationId": "ve9EPM428h8vShlRW1KT",
      "name": "Name",
      "description": "string",
      "placeholder": "string",
      "showInForms": true,
      "options": [
        {}
      ],
      "acceptedFormats": ".pdf",
      "id": "string",
      "objectKey": "custom_object.pet",
      "dataType": "TEXT",
      "parentId": "3v34PM428h8vShlRW1KT",
      "fieldKey": "custom_object.pet.name",
  // truncado: 7 lineas mas
}

Empezar

Scopes

Get Custom Fields By Object Key

Autorizacion

Path parameters

Query parameters

Respuestas

Ejemplo

Empezar

Scopes

Documentation Index

​Autorizacion

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorizacion

Path parameters

Query parameters

Respuestas

Ejemplo