OBJECT
FieldDescriptor

Description of a field: its names, type, the access level of the current user and its type-specific settings.
GraphQL Schema definition

type FieldDescriptor {
# Unique identifier of the field.
id: ID! 
# Name of the field; a translation key when useLang is true.
name: String! 
# Field name in the current user's language, taken from nameTranslations. Null 
# when no translation is available for that language.
nameTranslated: String 
# Map of locale codes to translated field names (e.g. {"en-US": "First name"}). 
# Empty when no translations are defined.
nameTranslations: JSONString! 
# Immutable name of the field used in the REST API and integrations; null for 
# fields without an API name.
apiName: String 
# Name of the field in the GraphQL API: apiName in camelCase. Null when the field 
# has no apiName.
graphqlName: String 
# Entity the field belongs to; CustomEntity for custom entities (see 
# entityApiName). Null for fields of an external service (see externalEntity).
entity: EntityNameEnum 
# API name of the custom entity the field belongs to; null for fields of other 
# entities.
entityApiName: String 
# Name of the entity in an external service (e.g. HubSpot or Salesforce) when the 
# descriptor describes a field of that service; null for Coevera fields.
externalEntity: String 
# When true, the field name is treated as a translation key and resolved through 
# the translation system; otherwise the literal name is shown.
useLang: Boolean! 
# Primitive value type of the field type (e.g. STRING, INT, BOOL, DATE).
primitiveType: PrimitiveType! 
# Id of the field type (e.g. input, dropdown, currency, lookup).
typeId: String! 
# Field type with its properties, such as whether it is filterable or sortable.
type: TypeEntity! 
# Type id of the values the field effectively holds: currency for a foreign 
# currency field, the type of the aggregated field for a rollup (integer for a 
# count), the result type of an advanced formula; otherwise the same as typeId.
sourceTypeId: String! 
# Id of the field that provides the values: the base value part of a foreign 
# currency field or the field aggregated by a rollup; otherwise the field itself. 
# Null for a rollup that counts records.
sourceFieldId: ID 
# Access level of the current user to the field.
permissionLevel: AccessLevelFieldEnum! 
# For enum fields, name of the enum type that lists the allowed values (e.g. 
# AccountClassEnum); null for other fields.
typeEnumClassName: String 
# True when the field is deleted.
isDeleted: Boolean! 
# Default value of the field, as text; null when none is set.
defaultValue: String 
# Id of this fields composite parent (main) field.
compositeFieldId: ID 
# Id of the data set holding the options of a dropdown, radio or multiselect 
# field; null for other fields.
dataSetId: ID 
# For dependent dropdown/radio fields, id of the parent field whose selected value 
# restricts the options shown on this field.
parentOptionsFieldId: ID 
# Formula used to calculate value of this field.
calcFormula: String 
# Id of sequence set used for this fields for auto incremented fields.
sequenceSetId: ID 
# Marks if field is required no matter what form validator says.
systemRequired: Boolean 
# Marks if field is readonly by default - cannot be updated.
systemReadonly: Boolean 
# Origin of the field: built-in, created by the space, or derived.
systemType: FieldSystemType! 
# When the field is shared between abstract entities (e.g. Lead and Opportunity), 
# id of the counterpart field on the other entity; null otherwise.
sharedWithFieldId: ID 
# Entities where field is allowed to be used,
# for relation fields both left relation entity and right relation entity record 
# is returned.
# Abstract Entity (e.g. LeadOppty, Activity) are not returned they have to be 
# evaluated by receiver.
allowedEntityTypes: [AllowedEntityType!]! 
# Properties for fields of type lookup. Otherwise null.
lookup: LookupProperty 
# Properties for fields of type rollup. Otherwise null.
rollup: RollupProperty 
# Formula used to calculate value of this field.
advancedFormula: AdvancedFormulaProperty 
# Type-specific settings of the field, such as the decimal places of a number or 
# the display of a record card; the union member depends on typeId. Null for types 
# without settings.
options: FieldOptionsProperty 
# AI Smart Field options. Available for input, text_area, integer, float, email, 
# phone, url, currency field types.
aiOptions: FieldAiOptions 
# Describes possible usage of field in application.
fieldUseOptions: FieldUseOptions 
# Values the field can take, with their labels, e.g. to offer them in a filter. 
# Empty when the field cannot be used in filters. Exactly one of entity or 
# externalEntity must be set.
# 
# Arguments
# entity: Entity on which the field is being used. This is used 
# to identify correct value options, e.g Using ActivityType (TaskType + 
# AppointmentType together) options when Task.type field is used on Activity 
# entity.
# externalEntity: Name of the entity in an external service (e.g. 
# HubSpot or Salesforce) the field belongs to; set instead of entity for fields of 
# that service.
# filter: Conditions that limit the returned options.
# first: Number of option items to return.
# after: Return items located after item with this id.
# typeIds: Limit result set to options with provided ids.
# inaccessibleLast: When true, deleted options are listed after 
# the others.
valueOptions(
entity: EntityNameEnum,
externalEntity: String,
filter: FieldValueOptionFilterInput,
first: Int,
after: ID,
typeIds: [String!],
inaccessibleLast: Boolean
): [FieldValueOption!] 
# For relation fields, the entity the field points to (e.g. Contact, Account); 
# null for other fields.
relatedEntity: String 
}
FieldDescriptor

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
