OBJECT

AccountEntity

Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.

link GraphQL Schema definition

  • type AccountEntity {
  • # Values of the record's custom fields as a JSON object keyed by custom field
  • # apiName (camelCase).
  • #
  • # Arguments
  • # apiNames: Api names of custom fields to retrieve. All are
  • # returned if not set.
  • customFields(apiNames: [String!]): JSONString!
  • # Filled only when a single record is read by its id; otherwise null or an empty
  • # list.
  • pendingScheduledActions: Int
  • # 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.
  • 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
  • # Account type that classifies this account. Account types are configurable per
  • # team space and drive which form, fields and pipelines apply.
  • accountType: AccountTypeEntity
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # account. Empty to inherit the team space default.
  • currencyExchangeRatesList: CurrencyExchangeRatesListEntity
  • # Customer category (e.g. Lead, Prospect, Customer). Configurable per team space.
  • customerType: DataEntity
  • # Industry the account operates in. Configurable per team space.
  • industry: DataEntity
  • # Sales user who owns this account.
  • owner: ClientEntity
  • # Parent account in a corporate hierarchy. Empty for top-level accounts.
  • parentAccount: AccountEntity
  • # Type of relationship to the parent account (e.g. subsidiary, branch). Required
  • # when parentAccount is set.
  • parentAccountRelationType: ParentAccountRelationTypeEntity
  • # Profile picture or company logo associated with the account.
  • picture: CloudObjectEntity
  • # Sales unit this account is assigned to. Determines which team members can see
  • # the record under unit-based sharing.
  • unit: SalesUnitEntity
  • # Manual classification grade assigned to the account. Used in segmentation and
  • # reporting.
  • accountClass: AccountClassEnum
  • # Id of the account type assigned to this account.
  • accountTypeId: ID
  • # Street address of the account.
  • address: String
  • # City of the account address.
  • city: String
  • # Free-form notes describing the account.
  • comments: String
  • # Country of the account address.
  • country: String
  • # Id of the currency exchange rate list applied to this account.
  • currencyExchangeRatesListId: ID
  • # Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the
  • # account.
  • customerTypeId: ID
  • # Primary email address of the account. 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
  • # Coarser bucket of healthStatus used for grouping and reporting. Read-only.
  • healthCategory: ID
  • # Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by
  • # Coevera when relevant fields change.
  • healthStatus: Int
  • # Website URL of the account. May be auto-filled from the primary email domain
  • # when domain extraction is enabled.
  • homePage: String
  • # Id of the industry classification.
  • industryId: ID
  • # True when the account has been archived. Archived accounts remain readable but
  • # are hidden from active lists and cannot be edited until reactivated.
  • isArchived: Boolean
  • # Time when an AI-suggested account hierarchy was last applied to this account.
  • lastAiAccountHierarchyApplied: DateTime
  • # Time when an AI-suggested org chart was last applied to this account.
  • lastAiOrgChartApplied: DateTime
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the account owner.
  • ownerId: ID!
  • # Id of the parent account in the corporate hierarchy. Empty for top-level
  • # accounts.
  • parentAccountId: ID
  • # Id of the parent-account relationship type.
  • parentAccountRelationTypeId: ID
  • # Primary phone number of the account. 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
  • # Free-text parent-account name used when the parent has not been linked to an
  • # actual Account record. Lets integrators note the relationship without creating a
  • # separate parent Account.
  • quickParentAccountName: String
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharingUnits /
  • # sharingClients lists control who is granted access.
  • shareMode: ShareModeEnum
  • # State or province of the account address.
  • stateProvince: String
  • # Id of the sales unit.
  • unitId: ID
  • # ZIP or postal code of the account address.
  • zipCode: String
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Display version of the account name, 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!
  • # Social network profiles linked to this account (e.g. LinkedIn, Facebook).
  • socialMedia: AccountSocialRelationEntity
  • # Sales units that have been granted shared access to this account. Editable only
  • # when shareMode allows unit sharing.
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter AccountSharingSalesUnitRelation relations by
  • # edge (relation) AccountSharingSalesUnitRelation 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: AccountSharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): AccountSharingSalesUnitRelationEntityConnection
  • # Users that have been granted shared access to this account. Editable only when
  • # shareMode allows user sharing.
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter AccountSharingClientRelation relations by
  • # edge (relation) AccountSharingClientRelation 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: AccountSharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): AccountSharingClientRelationEntityConnection
  • # Documents linked to this account.
  • #
  • # 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
  • # True when the current authenticated user has marked this account as favorite.
  • # Per-user.
  • isFavorite: Boolean!
  • # Filled only when a single record is read by its id; otherwise null or an empty
  • # list.
  • viewerIdsPerSalesUnit: [UUID!]!
  • # If account has any unsubscribed email.
  • isUnsubscribed: Boolean
  • # Tag labels applied to this account.
  • #
  • # 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 account 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
  • # Composite entity-health summary, combining current and previous state with
  • # last-calculation metadata. Read-only; computed by Coevera.
  • health: EntityHealthResult
  • # Timestamp of the most recent modification made by an end user (excluding system
  • # changes). Read-only; computed by Coevera.
  • modifiedByUser: DateTime
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Records of the given entity type that are related to this record, as a drilldown
  • # list.
  • #
  • # Arguments
  • # entityType: Entity type of the related records to list.
  • relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel!
  • # Data of the given preview pane charts and lists, computed for this record.
  • #
  • # Arguments
  • # ids: Ids of the charts to compute, taken from the charts of the
  • # record type's interface preview. Comment charts are not supported.
  • charts(ids: [UUID!]!): [DashboardChartData!]
  • # Records behind one preview pane chart of this record: all records of a list
  • # chart, or the records of a single data point of a report chart.
  • #
  • # Arguments
  • # id: Id of the chart, taken from the charts of the record type's
  • # interface preview.
  • # seriesIndex: Index of the series of the drilled-down data
  • # point. Required for report charts; must not be set for list charts.
  • # itemIndex: Index of the drilled-down data point within its
  • # series. Required for report charts; must not be set for list charts.
  • chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel!
  • # Values of the fields shown in the record's preview pane, as configured for the
  • # record's type.
  • #
  • # Arguments
  • # ids: Ids of the fields to return. When not set, the fields
  • # configured for the preview pane of the record's type are returned.
  • # first: Maximum number of preview pane fields to return when ids
  • # is not set; fields pinned by the current user come first.
  • fields(ids: [UUID!], first: Int): [InterfaceFieldData]!
  • # Approval request of this record that is pending or was rejected; null when there
  • # is none or it was approved.
  • approval: ApprovalEntity
  • }

link Require by