---
title: "Fields.get"
method: GET
path: "/entities/Fields/{id}"
tags: ["Field"]
---

# Fields.get

`GET /entities/Fields/{id}`

Returns Field with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Field data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Field
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `has_draft` boolean, required — Set to True if draft for entity exists and 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, ...)
    - `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 — A default value for field.
    - `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.
    - `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. Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.
    - `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 — Available option values for dropdown, radio, and multiselect-checkbox fields, including labels and translations. Empty for other field types.
    - `ai_options` object — AI Smart Field options. Available for input, text_area, integer, float, email, phone, url, currency.
    - `advanced_formula` object — Advanced calculated formula
    - `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). Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.
    - `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.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)