OBJECT
TaskEntity

Task (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
GraphQL Schema definition

type TaskEntity {
# 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! 
# Timestamp of the next pending reminder configured for the activity (reminder 
# time, due date or end date as applicable). Empty when no reminder is pending.
activeReminder: String 
# Id of the linked Media record holding the activity's call recording / 
# transcription, when available.
mediaTranscriptionId: UUID 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Task type that classifies this task (e.g. Task, Call, Email). Drives form layout 
# and icon.
activityType: TaskTypeEntity 
# Call record associated with this task when the task represents a phone call.
call: CallEntity 
# Configurable outcome of the call (e.g. Reached, Voicemail, No Answer).
callOutcome: DataEntity 
# Currency exchange rate list used to convert monetary fields linked to this task. 
# Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
# Sales user who owns this task. May be empty when the task is unassigned and 
# available for take-over.
owner: ClientEntity 
# Sales unit this task is assigned to. Determines which team members can see the 
# record under unit-based sharing.
unit: SalesUnitEntity 
# Id of the task type.
activityTypeId: ID 
# Duration of the recorded call. Set automatically when the task is linked to a 
# call log.
callDuration: Int 
# Id of the linked call record.
callId: ID 
# Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No 
# Answer).
callOutcomeId: ID 
# Id of the currency exchange rate list applied to this task.
currencyExchangeRatesListId: ID 
# Free-form description of what the task entails.
description: String 
# Date by which the task is expected to be completed.
dueDate: Date 
# Estimated duration of the task. Stored as a duration value (days/hours/minutes).
duration: Float 
# Id of the task owner.
ownerId: ID 
# Priority level of the task: Low, Medium or High.
priority: PriorityEnum 
# Sharing model applied on top of the owner/unit visibility (e.g. shared with 
# selected sales units or selected users).
shareMode: ShareModeEnum 
# Date when work on the task is scheduled to begin.
startDate: Date 
# Current status of the task (NotStarted, InProgress, Waiting, Completed, 
# Deferred). Toggling to Completed marks any linked checklist items as done.
status: TaskStatusEnum 
# Short summary line shown in lists and notifications.
subject: String! 
# Discriminator identifying the concrete record type — always "task" for Task 
# records. Read-only; useful when consuming polymorphic Activity results.
tableName: String! 
# Id of the sales unit.
unitId: ID 
# Revision when entity was lastly changed.
revision: Int 
# Sales units that have been granted shared access to this task. Editable only 
# when shareMode allows unit sharing.
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter TaskSharingSalesUnitRelation relations by 
# edge (relation) TaskSharingSalesUnitRelation 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: TaskSharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TaskSharingSalesUnitRelationEntityConnection 
# Users that have been granted shared access to this task. Editable only when 
# shareMode allows user sharing.
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter TaskSharingClientRelation relations by edge 
# (relation) TaskSharingClientRelation 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: TaskSharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TaskSharingClientRelationEntityConnection 
# Accounts this task is linked to.
# 
# Arguments
# filter: Filter Account relations by target Account attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation 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: ActivityRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Contacts this task is linked to.
# 
# Arguments
# filter: Filter Contact relations by target Contact attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order Contact relations by target Contact 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.
contactRelations(
filter: ContactFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Leads this task is linked to.
# 
# Arguments
# filter: Filter Lead relations by target Lead attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order Lead relations by target Lead 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.
leadRelations(
filter: LeadFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [LeadOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Opportunities this task is linked to.
# 
# Arguments
# filter: Filter Opportunity relations by target Opportunity 
# attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order Opportunity relations by target Opportunity 
# 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.
opportunityRelations(
filter: OpportunityFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [OpportunityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Projects this task is linked to, including the per-objective ordering.
# 
# Arguments
# filter: Filter Project relations by target Project attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order Project relations by target Project 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.
projectRelations(
filter: ProjectFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [ProjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Quotes this task is linked to.
# 
# Arguments
# filter: Filter Quote relations by target Quote attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order Quote relations by target Quote 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.
quoteRelations(
filter: QuoteFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [QuoteOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# Custom entity records this task is linked to.
# 
# Arguments
# filter: Filter CustomEntity relations by target CustomEntity 
# attributes.
# filterEdge: Filter ActivityRelation relations by edge 
# (relation) ActivityRelation attributes.
# orderBy: Order CustomEntity relations by target CustomEntity 
# 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.
customEntityRelations(
filter: CustomEntityFilterInput,
filterEdge: ActivityRelationFilterInput,
orderBy: [CustomEntityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityRelationEntityConnection 
# 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 
# Reminder set by the current authenticated user for this task. Per-user; empty 
# when no reminder has been set.
reminder: TaskReminderEntity 
# Recurrence schedule generating periodic copies of this task, or empty when no 
# recurrence is set up.
taskRecurrence: TaskRecurrenceEntity 
# Documents linked to this task.
# 
# 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 
# Comments authored on this task.
# 
# Arguments
# filter: Filter ActivityComment relations by target 
# ActivityComment attributes.
# orderBy: Order ActivityComment relations by target 
# ActivityComment 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.
comments(
filter: ActivityCommentFilterInput,
orderBy: [ActivityCommentOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ActivityCommentEntityConnection 
# Tag labels applied to this task.
# 
# 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 
# Display name of the task (alias of subject).
formattedName: String! 
# Filled only when a single record is read by its id; otherwise null or an empty 
# list.
viewerIdsPerSalesUnit: [UUID!]! 
# 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]! 
# Recording attached to this activity, with its transcription and summary when 
# available; null when there is none.
mediaTranscription: MediaEntity 
}
TaskEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
