githubEdit

CustomField

Attributes of the CustomField type

A custom field definition

Name
Type
Description

createdAt

ISO8601DateTime

fieldType

String

Data type: string, integer, date, rich_text, boolean

formColumn

String

Column position (start/end, e.g. 1/4, 4/7, 7/13). Counter: quarter +3, half +6, full +12.

graphqlFieldName

String

The prefixed GraphQL field name (e.g., customChurnDate)

id

ID

Unique ID for the custom field

label

String

Display label for the field

name

String

Schema name for the field (camelCase)

parentObject

String

Object type this field belongs to

position

Int

Sort order position

required

Boolean

Whether the field is required

size

String

Field size: quarter (1/4), half (1/2), full (1/1)

updatedAt

ISO8601DateTime

Last updated

Was this helpful?