result.data | object | Yes | — | Provider response payload. |
result.data.success | boolean | No | — | Whether the request was successful |
result.data.data | object | No | — | — |
result.data.data.field_name | string | Yes | — | The display name/label of the field |
result.data.data.field_code | string | Yes | — | The unique identifier for the field (40-character hash for custom fields) |
result.data.data.field_type | "int" | "double" | "boolean" | "varchar" | "text" | "phone" | "varchar_options" | "varchar_auto" | "date" | "daterange" | "time" | "timerange" | "enum" | "set" | "address" | "monetary" | "deal" | "deals" | "lead" | "org" | "people" | "project" | "stage" | "user" | "activity" | "json" | "picture" | "status" | "visible_to" | "price_list" | "billing_frequency" | "projects_board" | "projects_phase" | Yes | — | The type of the field Allowed: int, double, boolean, varchar, text, phone, varchar_options, varchar_auto, date, daterange, time, timerange, enum, set, address, monetary, deal, deals, lead, org, people, project, stage, user, activity, json, picture, status, visible_to, price_list, billing_frequency, projects_board, projects_phase. |
result.data.data.options | array | null | No | — | Array of available options for enum/set fields, null for other field types |
result.data.data.options[].id | record | No | — | The option ID (integer for custom fields, string for built-in fields) |
result.data.data.options[].label | string | No | — | The option display label |
result.data.data.options[].color | string | null | No | — | Optional color code for the option |
result.data.data.options[].update_time | string | null | No | — | When the option was last updated Format: date-time. |
result.data.data.options[].add_time | string | null | No | — | When the option was created Format: date-time. |
result.data.data.subfields | array | null | No | — | Array of subfields for complex field types (address, monetary), null for simple field types |
result.data.data.subfields[].field_code | string | No | — | The subfield identifier |
result.data.data.subfields[].field_name | string | No | — | The subfield display name |
result.data.data.subfields[].field_type | string | No | — | The subfield type |
result.data.data.is_custom_field | boolean | Yes | — | Whether this is a user-created custom field |
result.data.data.is_optional_response_field | boolean | Yes | — | Whether this field is not returned by default in entity responses |
result.data.data.ui_visibility | object | No | — | UI visibility settings (only included when requested via include_fields parameter) |
result.data.data.ui_visibility.add_visible_flag | boolean | No | — | Whether the field is shown in the add modal |
result.data.data.ui_visibility.details_visible_flag | boolean | No | — | Whether the field is shown in the details view (read-only) |
result.meta | object | No | — | Additional response metadata (status, paging). |