OBJECT
ContactEntity

GraphQL Schema definition

type ContactEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
pendingScheduledActions: Int 
#   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 
#   Contact type that classifies this contact. Contact types are configurable per 
#   team space and drive which form, fields and pipelines apply.
contactType: ContactTypeEntity 
#   Currency exchange rate list used to convert monetary fields linked to this 
#   contact. Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
#   Sales user who owns this contact.
owner: ClientEntity 
#   Profile picture associated with the contact.
picture: CloudObjectEntity 
#   Sales unit this contact is assigned to. Determines which team members can see 
#   the record under unit-based sharing.
unit: SalesUnitEntity 
#   Street address of the contact.
address: String 
#   City of the contact address.
city: String 
#   Free-form notes describing the contact.
comments: String 
#   Id of the contact type assigned to this contact.
contactTypeId: ID 
#   Country of the contact address.
country: String 
#   Id of the currency exchange rate list applied to this contact.
currencyExchangeRatesListId: ID 
#   Primary email address of the contact. Used as default recipient for emails sent 
#   from Coevera.
email1: String 
#   Additional email address.
email2: String 
#   Additional email address.
email3: String 
#   Additional email address.
email4: String 
#   Additional email address.
email5: String 
#   Given name of the contact.
firstName: String 
#   Gender of the contact (e.g. Male, Female, Other).
gender: GenderEnum 
#   True when the contact has been archived. Archived contacts remain readable but 
#   are hidden from active lists and cannot be edited until reactivated.
isArchived: Boolean 
#   Family name of the contact.
lastName: String 
#   Middle name of the contact, if applicable.
middleName: String 
#   Id of the contact owner.
ownerId: ID! 
#   Primary phone number of the contact. Used as default target for click-to-call.
phone1: String 
#   Additional phone number.
phone2: String 
#   Additional phone number.
phone3: String 
#   Additional phone number.
phone4: String 
#   Additional phone number.
phone5: String 
#   Id of the profile picture document.
pictureId: ID 
#   Job title or position of the contact.
position: String 
#   Free-text company name used when the contact is not linked to an actual Account 
#   record. Lets integrators capture the company without creating a separate 
#   Account.
quickAccountName: String 
#   Sharing model applied on top of the owner/unit visibility (e.g. shared with 
#   selected sales units or selected users). The matching sharing_units / 
#   sharing_clients lists control who is granted access.
shareMode: ShareModeEnum 
#   State or province of the contact address.
stateProvince: String 
#   Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
title: String 
#   Id of the sales unit.
unitId: ID 
#   ZIP or postal code of the contact address.
zipCode: String 
#   Revision when entity was lastly changed.
revision: Int 
#   Display version of the contact name (title, first, middle, last). Used in lists 
#   and references.
formattedName: String! 
#   Number of email sequences this record is currently actively enrolled in 
#   (soft-deleted or ended enrollments are not counted).
enrolledEmailSequences: Int! 
socialMedia: ContactSocialRelationEntity 
#   Primary account this contact belongs to. Set automatically when the contact has 
#   an account relation marked as primary.
primaryAccount: AccountEntity 
#   Accounts this contact is linked to. Each link records the role and position the 
#   contact has at the related account.
# 
# 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 
#   Sales units that have been granted shared access to this contact. Editable only 
#   when share_mode allows unit sharing.
# 
# 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 
#   Users that have been granted shared access to this contact. Editable only when 
#   share_mode allows user sharing.
# 
# 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 
#   Documents linked to this contact.
# 
# 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 
#   External identifier of the record in the linked third-party service (e.g. 
#   Google, Microsoft 365, Exchange). Maintained by the sync engine.
exchangeEntityId: String 
#   External identifier of the record in the linked third-party service (e.g. 
#   Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityId: String 
#   External identifier of the record in the linked third-party service (e.g. 
#   Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityId: String 
#   True when the current authenticated user has marked this contact as favorite. 
#   Per-user.
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!]! 
#   If account has any unsubscribed email.
isUnsubscribed: Boolean 
#   Tag labels applied to this contact.
# 
# 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 
#   Saved view profiles this contact currently matches.
# 
# Arguments
#   filter: Filter Profile relations by target Profile attributes.
#   filterEdge: Filter ProfileRelation relations by edge (relation) 
#   ProfileRelation attributes.
#   orderBy: Order Profile relations by target Profile 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.
staticProfiles(
filter: ProfileFilterInput,
filterEdge: ProfileRelationFilterInput,
orderBy: [ProfileOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProfileRelationEntityConnection 
#   Org chart relationship of Contact in his primary Account.
primaryAccountRelationship: String 
#   Timestamp of the most recent modification made by an end user (excluding system 
#   changes). Read-only; computed by Coevera.
modifiedByUser: DateTime 
#   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]! 
approval: ApprovalEntity 
}
ContactEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
