--- title: "Fields.list" method: GET path: "/entities/Fields" tags: ["Field"] --- # Fields.list `GET /entities/Fields` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Fields` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a page of Field records, optionally filtered, sorted and limited to selected fields. ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` Page of Field records. - object - `success` boolean: True when the request succeeded; false on error. - `data` Field[] - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `has_draft` boolean, required: True when the record has unpublished draft changes, including pending translation changes, that can be published. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: True when the field is marked as deleted (soft-delete). - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `entity_name` string, required: Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...). Must be a concrete entity: abstract parents such as LeadOppty or Activity are rejected. To share a field between Lead and Opportunity (or Task and Appointment), create it on one of them and set mapDependency to the other. - `api_name` string: Immutable and generated name. This name is used for integrations. - `name` string, required: User friendly name for field. - `use_lang` integer: When true, the field name is treated as a translation key and resolved through the translation system; otherwise the literal name is shown. - `column_name` string: Storage column name for the field; used as the filter key in API queries. - `column_source` integer: Storage origin of the field: on the main entity record, on the custom-field data record, or computed. - `relation_id` string: For relation-typed fields, identifier of the relation kind that connects this entity to the related entity. Empty for non-relation fields. - `relation_with_entity_id` string: For relation-typed fields, the entity the field points to (e.g. Contact, Account). Empty for non-relation fields. - `shared_with_field_id` string, uuid: When the field is shared between abstract entities (e.g. Lead and Opportunity), id of the counterpart field on the other entity. Empty when the field is not shared. - `system_type` integer: Whether the field is System (built-in, immutable), Protected (built-in, limited changes), or Custom (user-created). - `type_id` string, required: Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url - `composite_field_id` string, uuid: For sub-fields of a composite field (e.g. the value/currency parts of a foreign currency field), id of the parent composite field. Empty for top-level fields. - `data_set_id` string, uuid: Optional custom data set id can be set. - `parent_options_field_id` string, uuid: For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field. - `calc_formula` string: Calculated formula used for fields which supports calculation. - `default_value` string: Value pre-filled into this field on newly created records, as text converted to the field type; empty for no default. Accepted only by field types that support a default value. - `sequence_set_id` string, uuid: For sequence-typed fields, id grouping the FieldSequence rows that drive auto-numbering for this field. - `sequence_id` string, uuid: Deprecated; always returns null. Use sequence_set_id and FieldSequence instead. - `system_required` boolean: True when the field cannot be made optional (enforced by the platform). - `is_published` boolean: True when the field configuration is published; false while the field exists only as an unpublished draft. - `system_readonly` boolean: True when the field cannot be made writable (enforced by the platform). - `use_in_global_search` boolean: If this field is allowed in global search. - `settings` object: Type-specific configuration for the field (e.g. rollup definition, calculated formula, AI options). Shape depends on type_id; null for fields that need no extra configuration. This payload conforms to the `FieldOptionsProperty` JSON Schema (see the linked schema). - `is_unique` boolean: If true, then there will be an API validation if value of entity is unique. - `data_set` string, uri, required: For dropdown, radio, and multiselect-checkbox fields, the set of available options. Empty for other field types. Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `lookup` object: Lookup field definition. - `sequence_pattern` string: Deprecated - previously returned sequence pattern used for sequence type of field. - `sequence` object: Sequence field definition. - `rollup` object: Rollup field definition. - `options` object: Type-specific settings of the field, such as the decimal places of a number or the display of a record card; the shape depends on type_id. Empty for types without settings. - `ai_options` object: AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency. - `advanced_formula` object: Formula of a calculated formula field - the expression, its result type and display - as a JSON object conforming to the `AdvancedFormulaProperty` type; empty for other field types. - `source_field_id` string, required: For derived fields, id of the underlying source field that drives this field's value (e.g. the value side of a composite currency field). - `source_type_id` string, required: Underlying primitive type id of the field, after resolving composite/rollup/lookup wrappers. - `use_in_interface_preview` boolean, required: True when the field can be used in the record interface preview pane. - `translated_name` string, required: Field name resolved into the current user's language. When use_lang is true, the name is looked up via the translation system; otherwise name is returned as-is. - `field_permissions` string, uri, required: Per-user-role access overrides for this field. Empty when the field uses default access (full access for all roles). Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `original_dataset_field_id` string, uuid: When multiple dropdown/radio fields share a data set, id of the field that originally defined the data set. Null when this field is the originator or has no data set. - `name_translations` string, binary, required: Map of locale codes to translated field names (e.g. {"en-US": "First name", "de-DE": "Vorname"}). Empty when no translations are defined. - `name_translated` string, required: Field name in the current user's language, taken from name_translations. Empty when no translation is available for that language. - `primitive_type` string, required: Primitive value type of the field (e.g. STRING, INT, BOOL, DATE, ENUM), derived from source_type_id. - `is_readonly_on_recurrent_appointment` boolean, required: True when the field cannot be edited on individual occurrences of a recurring appointment (changes must be made on the recurrence master). - `is_available_for_webresource` boolean, required: True when the field can be referenced from a Webresource URL template. - `is_available_for_advanced_formula` boolean, required: True when the field can be used as an input in an advanced calculated formula expression on this entity. - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used. - `start_cursor` string: Cursor of the first record of the page. - `end_cursor` string: Cursor of the last record of the page. - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them. - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them. - `total` integer: Number of records that match the request, across all pages. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)