OBJECT

ContactEntity

link GraphQL Schema definition

  • type ContactEntity {
  • # Arguments
  • # apiNames: Api names of custom fields to retrieve. All are
  • # returned if not set.
  • customFields(apiNames: [String!]): JSONString!
  • # 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.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • contactType: ContactTypeEntity
  • owner: ClientEntity
  • picture: CloudObjectEntity
  • unit: SalesUnitEntity
  • # Multi-line text input field.
  • address: String
  • # Simple text input field.
  • city: String
  • # Multi-line text input field.
  • comments: String
  • # Relation to single entity instance.
  • contactTypeId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • country: String
  • # Email address.
  • email1: String
  • # Email address.
  • email2: String
  • # Email address.
  • email3: String
  • # Email address.
  • email4: String
  • # Email address.
  • email5: String
  • # Simple text input field.
  • firstName: String
  • # Field whose values are strictly defined with an enumeration of values.
  • gender: GenderEnum
  • # Simple text input field.
  • lastName: String
  • # Simple text input field.
  • middleName: String
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Phone number.
  • phone1: String
  • # Phone number.
  • phone2: String
  • # Phone number.
  • phone3: String
  • # Phone number.
  • phone4: String
  • # Phone number.
  • phone5: String
  • # Relation to single entity instance.
  • pictureId: ID
  • # Simple text input field.
  • position: String
  • # Simple text input field.
  • quickAccountName: String
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • # Simple text input field.
  • stateProvince: String
  • # Simple text input field.
  • title: String
  • # Relation to single entity instance.
  • unitId: ID
  • # Simple text input field.
  • zipCode: String
  • # Revision when entity was lastly changed.
  • revision: Int
  • formattedName: String!
  • enrolledEmailSequences: Int!
  • socialMedia: ContactSocialRelationEntity
  • # Primary Account.
  • primaryAccount: AccountEntity
  • # Relations to Accounts.
  • #
  • # Arguments
  • # filter: Filter Account relations by target Account attributes.
  • # filterEdge: Filter ContactAccountRelation relations by edge
  • # (relation) ContactAccountRelation attributes.
  • # orderBy: Order Account relations by target Account attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • accountRelations(
  • filter: AccountFilterInput,
  • filterEdge: ContactAccountRelationFilterInput,
  • orderBy: [AccountOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ContactAccountRelationEntityConnection
  • # Relations to SalesUnits.
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter ContactSharingSalesUnitRelation relations by
  • # edge (relation) ContactSharingSalesUnitRelation attributes.
  • # orderBy: Order SalesUnit relations by target SalesUnit
  • # attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • sharingUnits(
  • filter: SalesUnitFilterInput,
  • filterEdge: ContactSharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ContactSharingSalesUnitRelationEntityConnection
  • # Relations to Clients.
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter ContactSharingClientRelation relations by
  • # edge (relation) ContactSharingClientRelation attributes.
  • # orderBy: Order Client relations by target Client attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • sharingClients(
  • filter: ClientFilterInput,
  • filterEdge: ContactSharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ContactSharingClientRelationEntityConnection
  • # Relations to CloudObjects.
  • #
  • # Arguments
  • # filter: Filter CloudObject relations by target CloudObject
  • # attributes.
  • # filterEdge: Filter CloudObjectRelation relations by edge
  • # (relation) CloudObjectRelation attributes.
  • # orderBy: Order CloudObject relations by target CloudObject
  • # attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • documents(
  • filter: CloudObjectFilterInput,
  • filterEdge: CloudObjectRelationFilterInput,
  • orderBy: [CloudObjectOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): CloudObjectRelationEntityConnection
  • isFavorite: Boolean!
  • # Roles of Contact in his primary Account.
  • primaryAccountAccountRoles: [ContactAccountAccountRoleRelationEntity!]
  • # Job position of Contact in his primary Account.
  • primaryAccountPosition: String
  • # Job position of Contact in his primary Account or quick account position if
  • # Contact has no primary Account.
  • accountPosition: String
  • # Deferred property. Will return data only if called via get_by_id. Otherwise null
  • # or empty array is used.
  • viewerIdsPerSalesUnit: [UUID!]!
  • # Deferred property. Will return data only if called via get_by_id. Otherwise null
  • # or empty array is used.
  • pendingScheduledActions: Int
  • # If account has any unsubscribed email.
  • isUnsubscribed: Boolean
  • # Relations to Tags.
  • #
  • # Arguments
  • # filter: Filter Tag relations by target Tag attributes.
  • # filterEdge: Filter TagRelation relations by edge (relation)
  • # TagRelation attributes.
  • # orderBy: Order Tag relations by target Tag attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • tags(
  • filter: TagFilterInput,
  • filterEdge: TagRelationFilterInput,
  • orderBy: [TagOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TagRelationEntityConnection
  • # Org chart relationship of Contact in his primary Account.
  • primaryAccountRelationship: String
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # entityType: [Not documented]
  • relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel!
  • # Arguments
  • # ids: [Not documented]
  • charts(ids: [UUID!]!): [DashboardChartData!]
  • # Arguments
  • # id: [Not documented]
  • # seriesIndex: [Not documented]
  • # itemIndex: [Not documented]
  • chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel!
  • # Arguments
  • # ids: Null to load all fields defined on InterfacePreview entity
  • # first: [Not documented]
  • fields(ids: [UUID!], first: Int): [InterfaceFieldData]!
  • }