Custom Form Fields
The custom_form_fields table contains data about fields in custom forms in the organization, which are displayed when entities are created or conversations are logged.
This table can be used to determine which fields are present in which custom forms, as well as metadata about the custom form field such as when it was created.
Columns
| Column Name | Description | Type | Nullable |
|---|---|---|---|
| id | The numerical identifier of the object. | INT8 | No |
| custom_form_id | The numerical identifier of the custom form this field is related to. Relates to the id column in the custom_forms table. |
INT8 | No |
| position | The relative position of this field in the custom form. | INT4 | No |
| required | Whether this field is required or not. | BOOL | Yes |
| field_object_type | The type of object this field represents. One of TagCategory, PhoneNumber, GlobalNote, Email, Address, or Entity. |
VARCHAR | No |
| field_object_id | The numerical identifier of the field used for the custom form. Can be used with field_object_type to look up the object itself in the appropriate table. |
INT4 | Yes |
| object_attribute | The attribute on the above object used in the form. For example, assessment on the Entity column object type means this form is collecting assessments on entities. |
VARCHAR | Yes |
| object_data | This column is currently unused. | JSONB | Yes |
| created_by_id | The numerical identifier of the user who created this custom form field. Relates to the id column in the users table. |
INT8 | No |
| deleted_by_id | The numerical identifier of the user who deleted this custom form field. Relates to the id column in the users table. |
INT8 | Yes |
| created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
| updated_at | The UTC timestamp when this object was updated. | TIMESTAMP | No |