Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriestask

entities.task

Read task records with the task repository, and change them with the task mutations. Same records as the REST Tasks entity.

Queries

Fields of entities { task { … } }.

Each operation opens an example built from the schema and checked against it on every build. Replace the placeholders, such as <task id>, with values from your space.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
TaskEntity
Example
Example: getById
query TaskGetById {
  entities {
    task {
      getById(entityId: "<task id>") {
        id
        formattedName
        subject
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetById { entities { task { getById(entityId: \"<task id>\") { id formattedName subject modified } } } }"}'
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[TaskEntity!]!
Example
Example: getByIds
query TaskGetByIds {
  entities {
    task {
      getByIds(entityIds: ["<task id>"]) {
        id
        formattedName
        subject
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetByIds { entities { task { getByIds(entityIds: [\"<task id>\"]) { id formattedName subject modified } } } }"}'
QUERYgetAll(limit: Int, offset: Int, filter: TaskFilterInput, orderBy: [TaskOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[TaskEntity!]!
Example
Example: getAll
query TaskGetAll {
  entities {
    task {
      getAll(limit: 10) {
        id
        formattedName
        subject
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetAll { entities { task { getAll(limit: 10) { id formattedName subject modified } } } }"}'
QUERYgetByCriteria(filter: TaskFilterInput, orderBy: [TaskOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
TaskEntityConnection
Example
Example: getByCriteria
query TaskGetByCriteria {
  entities {
    task {
      getByCriteria(first: 10) {
        totalCount
        edges {
          node {
            id
            formattedName
            subject
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetByCriteria { entities { task { getByCriteria(first: 10) { totalCount edges { node { id formattedName subject modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!
Example
Example: getChangedFieldsSinceRevision
query TaskGetChangedFieldsSinceRevision {
  entities {
    task {
      getChangedFieldsSinceRevision(id: "<task id>", revision: 10)
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetChangedFieldsSinceRevision { entities { task { getChangedFieldsSinceRevision(id: \"<task id>\", revision: 10) } } }"}'
QUERYgetBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int)
Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.
TaskEntityConnection
Example
Example: getBySession
query TaskGetBySession {
  entities {
    task {
      getBySession(
        includedIds: ["<task id>"]
        excludedIds: ["<task id>"]
        sessionId: "<session id>"
        first: 10
      ) {
        totalCount
        edges {
          node {
            id
            formattedName
            subject
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetBySession { entities { task { getBySession( includedIds: [\"<task id>\"] excludedIds: [\"<task id>\"] sessionId: \"<session id>\" first: 10 ) { totalCount edges { node { id formattedName subject modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetByIdFormatted(id: UUID!, fieldIds: [UUID!])
Returns the values of a record's fields formatted for display, keyed by field id.
JSONString
Example
Example: getByIdFormatted
query TaskGetByIdFormatted {
  entities {
    task {
      getByIdFormatted(id: "<task id>")
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskGetByIdFormatted { entities { task { getByIdFormatted(id: \"<task id>\") } } }"}'
QUERYautoPrefill(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID)
Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.
TaskEntity!
Example
Example: autoPrefill
query TaskAutoPrefill {
  entities {
    task {
      autoPrefill(mappingId: "<mapping id>", entityId: "<task id>") {
        id
        formattedName
        subject
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskAutoPrefill { entities { task { autoPrefill(mappingId: \"<mapping id>\", entityId: \"<task id>\") { id formattedName subject modified } } } }"}'
QUERYaiAutoPrefill(actionId: String!)
Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in.
TaskAutoPrefill!
Example
Example: aiAutoPrefill
query TaskAiAutoPrefill {
  entities {
    task {
      aiAutoPrefill(actionId: "<action id>") {
        entity {
          id
          formattedName
          subject
          modified
        }
        fieldIds
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskAiAutoPrefill { entities { task { aiAutoPrefill(actionId: \"<action id>\") { entity { id formattedName subject modified } fieldIds } } } }"}'
QUERYautoPrefillFromEmail(emailId: UUID!, mailboxId: UUID)
Returns a new, unsaved task pre-filled from an email conversation: subject and description from the last sent email of the conversation that the user can read, the records linked to the conversation (including ones the …
TaskAutoPrefill!
Example
Example: autoPrefillFromEmail
query TaskAutoPrefillFromEmail {
  entities {
    task {
      autoPrefillFromEmail(emailId: "<email id>") {
        entity {
          id
          formattedName
          subject
          modified
        }
        fieldIds
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query TaskAutoPrefillFromEmail { entities { task { autoPrefillFromEmail(emailId: \"<email id>\") { entity { id formattedName subject modified } fieldIds } } } }"}'

Mutations

KindMutationDoesReturns
MUTATIONchangeOwnershipTask(input: ChangeOwnershipTaskInput!)Change owner GraphQL onlyChangeOwnershipTaskPayload
Example
Example: changeOwnershipTask
mutation ChangeOwnershipTask {
  changeOwnershipTask(
    input: {ownerId: "<owner id>", unitId: "<unit id>", keepOwnerAsEditor: false, id: "<task id>"}
  ) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ChangeOwnershipTask { changeOwnershipTask( input: {ownerId: \"<owner id>\", unitId: \"<unit id>\", keepOwnerAsEditor: false, id: \"<task id>\"} ) { result { id formattedName subject modified } } }"}'
MUTATIONreleaseOwnershipTask(input: ReleaseOwnershipTaskInput!)Release ownership GraphQL onlyReleaseOwnershipTaskPayload
Example
Example: releaseOwnershipTask
mutation ReleaseOwnershipTask {
  releaseOwnershipTask(input: {id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ReleaseOwnershipTask { releaseOwnershipTask(input: {id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONmanageSharingTask(input: ManageSharingTaskInput!)Change who it is shared with GraphQL onlyManageSharingTaskPayload
Example
Example: manageSharingTask
mutation ManageSharingTask {
  manageSharingTask(input: {shareMode: Standard, id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ManageSharingTask { manageSharingTask(input: {shareMode: Standard, id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONrestoreTask(input: RestoreTaskInput!)Restore a deleted recordRestoreTaskPayload
Example
Example: restoreTask
mutation RestoreTask {
  restoreTask(input: {id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation RestoreTask { restoreTask(input: {id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONsetReminderTask(input: SetReminderTaskInput!)Set a reminder GraphQL onlySetReminderTaskPayload
Example
Example: setReminderTask
mutation SetReminderTask {
  setReminderTask(input: {id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation SetReminderTask { setReminderTask(input: {id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONremoveReminderTask(input: RemoveReminderTaskInput!)Remove the reminder GraphQL onlyRemoveReminderTaskPayload
Example
Example: removeReminderTask
mutation RemoveReminderTask {
  removeReminderTask(input: {id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation RemoveReminderTask { removeReminderTask(input: {id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONsetTaskStatus(input: SetTaskStatusInput!)Changes the status of the task, for example to InProgress or Completed. GraphQL onlySetTaskStatusPayload
Example
Example: setTaskStatus
mutation SetTaskStatus {
  setTaskStatus(input: {newStatus: NotStarted, id: "<task id>"}) {
    result {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation SetTaskStatus { setTaskStatus(input: {newStatus: NotStarted, id: \"<task id>\"}) { result { id formattedName subject modified } } }"}'
MUTATIONcreateTask(input: CreateTaskInput!, validationLevel: [ValidationLevel!])Create one recordCreateTaskPayload
Example
Example: createTask
mutation CreateTask {
  createTask(input: {subject: "Call Northwind Analytics"}) {
    task {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation CreateTask { createTask(input: {subject: \"Call Northwind Analytics\"}) { task { id formattedName subject modified } } }"}'
MUTATIONupdateTask(input: UpdateTaskInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateTaskPayload
Example
Example: updateTask
mutation UpdateTask {
  updateTask(input: {id: "<task id>"}) {
    task {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation UpdateTask { updateTask(input: {id: \"<task id>\"}) { task { id formattedName subject modified } } }"}'
MUTATIONbulkUpdateTask(input: [CreateOrUpdateTaskInput!]!, deleteInput: [DeleteTaskInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateTaskPayload
Example
Example: bulkUpdateTask
mutation BulkUpdateTask {
  bulkUpdateTask(input: [{id: "<task id>"}]) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkUpdateTask { bulkUpdateTask(input: [{id: \"<task id>\"}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONdeleteTask(input: DeleteTaskInput!)Soft-deleteDeleteTaskPayload
Example
Example: deleteTask
mutation DeleteTask {
  deleteTask(input: {id: "<task id>"}) {
    task {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation DeleteTask { deleteTask(input: {id: \"<task id>\"}) { task { id formattedName subject modified } } }"}'
MUTATIONconvertTask(input: CreateTaskInput!, sourceEntity: EntityNameEnum!, sourceEntityId: UUID!, operation: RecordConversionOperationEnum!, options: RecordConversionOptions!, sourceEntityApiName: String, validationLevel: [ValidationLevel!])Create from another record GraphQL onlyConvertTaskPayload
Example
Example: convertTask
mutation ConvertTask {
  convertTask(
    input: {subject: "Call Northwind Analytics"}
    sourceEntity: AiAgent
    sourceEntityId: "<source entity id>"
    operation: Nothing
    options: {}
  ) {
    task {
      id
      formattedName
      subject
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ConvertTask { convertTask( input: {subject: \"Call Northwind Analytics\"} sourceEntity: AiAgent sourceEntityId: \"<source entity id>\" operation: Nothing options: {} ) { task { id formattedName subject modified } } }"}'

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

TaskEntity object 58 fields: customFields, pendingScheduledActions, isDeleteProtected, …

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

FieldTypeDescription
customFieldsJSONString! (1 args)Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
pendingScheduledActionsIntFilled only when a single record is read by its id; otherwise null or an empty list.
isDeleteProtectedBoolean!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.
idID!Unique identifier of entity.
activeReminderStringTimestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending.
mediaTranscriptionIdUUIDId of the linked Media record holding the activity's call recording / transcription, when available.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
activityTypeTaskTypeEntityTask type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon.
callCallEntityCall record associated with this task when the task represents a phone call.
callOutcomeDataEntityConfigurable outcome of the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListCurrencyExchangeRatesListEntityCurrency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default.
ownerClientEntitySales user who owns this task. May be empty when the task is unassigned and available for take-over.
unitSalesUnitEntitySales unit this task is assigned to. Determines which team members can see the record under unit-based sharing.
activityTypeIdIDId of the task type.
callDurationIntDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdIDId of the linked call record.
callOutcomeIdIDId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this task.
descriptionStringFree-form description of what the task entails.
dueDateDateDate by which the task is expected to be completed.
durationFloatEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdIDId of the task owner.
priorityPriorityEnumPriority level of the task: Low, Medium or High.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateDateDate when work on the task is scheduled to begin.
statusTaskStatusEnumCurrent status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.
subjectString!Short summary line shown in lists and notifications.
tableNameString!Discriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results.
unitIdIDId of the sales unit.
revisionIntRevision when entity was lastly changed.
sharingUnitsTaskSharingSalesUnitRelationEntityConnection (8 args)Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing.
sharingClientsTaskSharingClientRelationEntityConnection (8 args)Users that have been granted shared access to this task. Editable only when shareMode allows user sharing.
accountRelationsActivityRelationEntityConnection (8 args)Accounts this task is linked to.
contactRelationsActivityRelationEntityConnection (8 args)Contacts this task is linked to.
leadRelationsActivityRelationEntityConnection (8 args)Leads this task is linked to.
opportunityRelationsActivityRelationEntityConnection (8 args)Opportunities this task is linked to.
projectRelationsActivityRelationEntityConnection (8 args)Projects this task is linked to, including the per-objective ordering.
quoteRelationsActivityRelationEntityConnection (8 args)Quotes this task is linked to.
customEntityRelationsActivityRelationEntityConnection (8 args)Custom entity records this task is linked to.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
reminderTaskReminderEntityReminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set.
taskRecurrenceTaskRecurrenceEntityRecurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.
documentsCloudObjectRelationEntityConnection (8 args)Documents linked to this task.
commentsActivityCommentEntityConnection (7 args)Comments authored on this task.
tagsTagRelationEntityConnection (8 args)Tag labels applied to this task.
formattedNameString!Display name of the task (alias of subject).
viewerIdsPerSalesUnit[UUID!]!Filled only when a single record is read by its id; otherwise null or an empty list.
modifiedByUserDateTimeTimestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
relatedEntitiesDrilldownCompactViewDrilldownModel! (1 args)Records of the given entity type that are related to this record, as a drilldown list.
charts[DashboardChartData!] (1 args)Data of the given preview pane charts and lists, computed for this record.
chartsDrilldownCompactViewDrilldownModel! (3 args)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.
fields[InterfaceFieldData]! (2 args)Values of the fields shown in the record's preview pane, as configured for the record's type.
mediaTranscriptionMediaEntityRecording attached to this activity, with its transcription and summary when available; null when there is none.
TaskEntityConnection object pageInfo: PageInfo!, edges: [TaskEntityEdge]!, totalCount: Int

Paginated list of Task records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[TaskEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
TaskEntityEdge object node: TaskEntity, cursor: String!

A Relay edge containing a TaskEntity and its cursor.

FieldTypeDescription
nodeTaskEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
PriorityEnumFilterInput input eq: [PriorityEnum!], NOT: PriorityEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[PriorityEnum!]Matches any of the listed values.
NOTPriorityEnumFilterInputMatches values that do not meet this condition.
TaskFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for Task records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[TaskFilterInput!]Matches records that meet at least one of the listed filters.
AND[TaskFilterInput!]Matches records that meet all of the listed filters.
NOTTaskFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
activityTypeIdEntityFilterStringFieldId of the task type.
callDurationEntityFilterNumberFieldDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdEntityFilterStringFieldId of the linked call record.
callOutcomeIdEntityFilterStringFieldId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdEntityFilterStringFieldId of the currency exchange rate list applied to this task.
descriptionEntityFilterStringFieldFree-form description of what the task entails.
durationEntityFilterNumberFieldEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdEntityFilterStringFieldId of the task owner.
priorityPriorityEnumFilterInputPriority level of the task: Low, Medium or High.
shareModeShareModeEnumFilterInputSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
statusTaskStatusEnumFilterInputCurrent status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.
subjectEntityFilterStringFieldShort summary line shown in lists and notifications.
tableNameEntityFilterStringFieldDiscriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results.
unitIdEntityFilterStringFieldId of the sales unit.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
withCustom[CustomField!]Conditions on custom fields, each identified by its api name. All listed conditions must match.
activityTypeTaskTypeFilterInputTask type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Matches records where a related record meets these conditions.
callCallFilterInputCall record associated with this task when the task represents a phone call. Matches records where a related record meets these conditions.
callOutcomeDataFilterInputConfigurable outcome of the call (e.g. Reached, Voicemail, No Answer). Matches records where a related record meets these conditions.
currencyExchangeRatesListCurrencyExchangeRatesListFilterInputCurrency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Matches records where a related record meets these conditions.
ownerClientFilterInputSales user who owns this task. May be empty when the task is unassigned and available for take-over. Matches records where a related record meets these conditions.
unitSalesUnitFilterInputSales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions.
sharingUnitsTaskSharingSalesUnitRelationFilterInputSales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions.
sharingClientsTaskSharingClientRelationFilterInputUsers that have been granted shared access to this task. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions.
accountRelationsActivityRelationFilterInputAccounts this task is linked to. Matches records where a related record meets these conditions.
contactRelationsActivityRelationFilterInputContacts this task is linked to. Matches records where a related record meets these conditions.
leadRelationsActivityRelationFilterInputLeads this task is linked to. Matches records where a related record meets these conditions.
opportunityRelationsActivityRelationFilterInputOpportunities this task is linked to. Matches records where a related record meets these conditions.
projectRelationsActivityRelationFilterInputProjects this task is linked to, including the per-objective ordering. Matches records where a related record meets these conditions.
quoteRelationsActivityRelationFilterInputQuotes this task is linked to. Matches records where a related record meets these conditions.
customEntityRelationsActivityRelationFilterInputCustom entity records this task is linked to. Matches records where a related record meets these conditions.
reminderTaskReminderFilterInputReminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Matches records where a related record meets these conditions.
taskRecurrenceTaskRecurrenceFilterInputRecurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Matches records where a related record meets these conditions.
documentsCloudObjectRelationFilterInputDocuments linked to this task. Matches records where a related record meets these conditions.
commentsActivityCommentFilterInputComments authored on this task. Matches records where a related record meets these conditions.
tagsTagRelationFilterInputTag labels applied to this task. Matches records where a related record meets these conditions.
TaskOrderByInput input Asc or Desc per field

Sorting of Task records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
activityType[TaskTypeOrderByNestedInput!]Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Sorts by fields of the related record, listed in order of priority.
call[CallOrderByNestedInput!]Call record associated with this task when the task represents a phone call. Sorts by fields of the related record, listed in order of priority.
callOutcome[DataOrderByNestedInput!]Configurable outcome of the call (e.g. Reached, Voicemail, No Answer). Sorts by fields of the related record, listed in order of priority.
currencyExchangeRatesList[CurrencyExchangeRatesListOrderByNestedInput!]Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority.
owner[ClientOrderByNestedInput!]Sales user who owns this task. May be empty when the task is unassigned and available for take-over. Sorts by fields of the related record, listed in order of priority.
unit[SalesUnitOrderByNestedInput!]Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority.
activityTypeIdOrderByEnumId of the task type.
callDurationOrderByEnumDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdOrderByEnumId of the linked call record.
callOutcomeIdOrderByEnumId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this task.
descriptionOrderByEnumFree-form description of what the task entails.
dueDateOrderByEnumDate by which the task is expected to be completed.
durationOrderByEnumEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdOrderByEnumId of the task owner.
priorityOrderByEnumPriority level of the task: Low, Medium or High.
shareModeOrderByEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateOrderByEnumDate when work on the task is scheduled to begin.
subjectOrderByEnumShort summary line shown in lists and notifications.
unitIdOrderByEnumId of the sales unit.
revisionOrderByEnumRevision when entity was lastly changed.
exchangeEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
reminder[TaskReminderOrderByNestedInput!]Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Sorts by fields of the related record, listed in order of priority.
taskRecurrence[TaskRecurrenceOrderByNestedInput!]Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Sorts by fields of the related record, listed in order of priority.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
TaskStatusEnumFilterInput input eq: [TaskStatusEnum!], NOT: TaskStatusEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[TaskStatusEnum!]Matches any of the listed values.
NOTTaskStatusEnumFilterInputMatches values that do not meet this condition.
ChangeOwnershipTaskInput input 5 fields: ownerId, unitId, keepOwnerAsEditor, …

Parameters of the changeOwnershipTask mutation.

Input fieldTypeDescription
ownerIdID!User who becomes the new owner of the task.
unitIdID!Sales unit the task is assigned to.
keepOwnerAsEditorBoolean!When true, the previous owner (if still an active user) stays on the task as a shared user with the Editor role, and a Private sharing mode is switched to Standard.
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateOrUpdateTaskInput input 40 fields: clientMutationId, id, mediaTranscriptionId, …

Field values of a Task record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idIDUnique identifier of entity.
mediaTranscriptionIdUUIDId of the linked Media record holding the activity's call recording / transcription, when available.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
activityTypeIdIDId of the task type.
callDurationIntDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdIDId of the linked call record.
callOutcomeIdIDId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this task.
descriptionStringFree-form description of what the task entails.
dueDateDateDate by which the task is expected to be completed.
durationFloatEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdIDId of the task owner.
priorityPriorityEnumPriority level of the task: Low, Medium or High.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateDateDate when work on the task is scheduled to begin.
statusTaskStatusEnumCurrent status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.
subjectStringShort summary line shown in lists and notifications.
unitIdIDId of the sales unit.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
sharingUnits[CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!]Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing.
sharingClients[CreateTaskSharingClientRelationNoTaskBackrefInput!]Users that have been granted shared access to this task. Editable only when shareMode allows user sharing.
accountRelations[CreateActivityRelationNoActivityBackrefInput!]Accounts this task is linked to.
contactRelations[CreateActivityRelationNoActivityBackrefInput!]Contacts this task is linked to.
leadRelations[CreateActivityRelationNoActivityBackrefInput!]Leads this task is linked to.
opportunityRelations[CreateActivityRelationNoActivityBackrefInput!]Opportunities this task is linked to.
projectRelations[CreateActivityRelationNoActivityBackrefInput!]Projects this task is linked to, including the per-objective ordering.
quoteRelations[CreateActivityRelationNoActivityBackrefInput!]Quotes this task is linked to.
customEntityRelations[CreateActivityRelationNoActivityBackrefInput!]Custom entity records this task is linked to.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
reminderUpdateTaskReminderNoTaskBackrefInputReminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set.
taskRecurrenceUpdateTaskRecurrenceNoTaskBackrefInputRecurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this task.
comments[CreateActivityCommentNoActivityBackrefInput!]Comments authored on this task.
tags[CreateTagRelationNoTaskBackrefInput!]Tag labels applied to this task.
callSidStringIdentifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only.
CreateTagRelationNoTaskBackrefInput input 15 fields: modified, created, accountId, …

Field values of a new TagRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdIDId of the linked account.
appointmentIdIDId of the linked appointment.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
emailIdIDId of the linked email.
leadIdIDId of the linked lead.
opptyIdIDId of the linked opportunity.
processIdIDId of the linked sales process.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
solutionIdIDId of the linked solution.
tagIdID!Id of the tag attached to the record.
revisionIntRevision when entity was lastly changed.
CreateTaskInput input 36 fields: clientMutationId, mediaTranscriptionId, modified, …

Field values of a new Task record.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
mediaTranscriptionIdUUIDId of the linked Media record holding the activity's call recording / transcription, when available.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
activityTypeIdIDId of the task type.
callDurationIntDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdIDId of the linked call record.
callOutcomeIdIDId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this task.
descriptionStringFree-form description of what the task entails.
dueDateDateDate by which the task is expected to be completed.
durationFloatEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdIDId of the task owner.
priorityPriorityEnumPriority level of the task: Low, Medium or High.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateDateDate when work on the task is scheduled to begin.
statusTaskStatusEnumCurrent status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.
subjectString!Short summary line shown in lists and notifications.
unitIdIDId of the sales unit.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
sharingUnits[CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!]Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing.
sharingClients[CreateTaskSharingClientRelationNoTaskBackrefInput!]Users that have been granted shared access to this task. Editable only when shareMode allows user sharing.
accountRelations[CreateActivityRelationNoActivityBackrefInput!]Accounts this task is linked to.
contactRelations[CreateActivityRelationNoActivityBackrefInput!]Contacts this task is linked to.
leadRelations[CreateActivityRelationNoActivityBackrefInput!]Leads this task is linked to.
opportunityRelations[CreateActivityRelationNoActivityBackrefInput!]Opportunities this task is linked to.
projectRelations[CreateActivityRelationNoActivityBackrefInput!]Projects this task is linked to, including the per-objective ordering.
quoteRelations[CreateActivityRelationNoActivityBackrefInput!]Quotes this task is linked to.
customEntityRelations[CreateActivityRelationNoActivityBackrefInput!]Custom entity records this task is linked to.
reminderCreateTaskReminderNoTaskBackrefInputReminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set.
taskRecurrenceCreateTaskRecurrenceNoTaskBackrefInputRecurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this task.
comments[CreateActivityCommentNoActivityBackrefInput!]Comments authored on this task.
tags[CreateTagRelationNoTaskBackrefInput!]Tag labels applied to this task.
callSidStringIdentifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only.
CreateTaskRecurrenceNoTaskBackrefInput input 13 fields: applyRecurrence, modified, created, …

Field values of a new TaskRecurrence record, created together with the record it belongs to.

Input fieldTypeDescription
applyRecurrenceBooleanDefault true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
dayDateDayEnumField whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
dayOfWeekIntBit Flag field, with limited combination of integer values.
endDateDateDate information. The last date when no more other items should be created.
monthDateMonthEnumField whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
occurEveryIntThe number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
occurrencesCountIntWhole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
startDateDate!Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
typeRecurrenceTypeEnumRecurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
weekDateWeekEnumField whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
revisionIntRevision when entity was lastly changed.
CreateTaskReminderNoTaskBackrefInput input 6 fields: modified, created, ownerId, …

Field values of a new TaskReminder record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
ownerIdID!Id of the user who set the reminder.
setDateDateTime!Timestamp when the reminder should fire.
statusReminderStatusEnumCurrent state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
revisionIntRevision when entity was lastly changed.
CreateTaskSharingClientRelationNoTaskBackrefInput input 5 fields: modified, created, clientId, …

Field values of a new TaskSharingClientRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
clientIdID!Id of the user.
roleSharingRoleEnumAccess the sharing gives the user on the task: Watcher can view it, Editor can view and edit it.
revisionIntRevision when entity was lastly changed.
CreateTaskSharingSalesUnitRelationNoTaskBackrefInput input 5 fields: modified, created, role, …

Field values of a new TaskSharingSalesUnitRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
roleSharingRoleEnumAccess the sharing gives the sales unit on the task: Watcher can view it, Editor can view and edit it.
unitIdID!Id of the sales unit.
revisionIntRevision when entity was lastly changed.
DeleteTaskInput input clientMutationId: String, id: ID!

Id of the Task record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
ManageSharingTaskInput input 5 fields: shareMode, sharingClients, sharingUnits, …

Parameters of the manageSharingTask mutation.

Input fieldTypeDescription
shareModeShareModeEnum!Sharing mode of the record: Standard, Private, AllView or AllEdit.
sharingClients[CreateTaskSharingClientRelationNoTaskBackrefInput!]Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users.
sharingUnits[CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!]Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units.
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ReleaseOwnershipTaskInput input id: ID!, clientMutationId: String

Parameters of the releaseOwnershipTask mutation.

Input fieldTypeDescription
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RemoveReminderTaskInput input id: ID!, clientMutationId: String

Parameters of the removeReminderTask mutation.

Input fieldTypeDescription
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreTaskInput input id: ID!, clientMutationId: String

Parameters of the restoreTask mutation.

Input fieldTypeDescription
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
SetReminderTaskInput input setDate: DateTime, status: ReminderStatusEnum, id: ID!, clientMutationId: String

Parameters of the setReminderTask mutation.

Input fieldTypeDescription
setDateDateTimeWhen the reminder fires; also used as the new time when snoozing. When a first reminder is created without a date and without the Scheduled status, it defaults to today at the user's default task reminder time.
statusReminderStatusEnumState of the reminder: Scheduled, Snoozed or Dismissed. Omit to keep the current state.
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
SetTaskStatusInput input newStatus: TaskStatusEnum!, id: ID!, clientMutationId: String

Parameters of the setTaskStatus mutation.

Input fieldTypeDescription
newStatusTaskStatusEnum!New status of the task.
idID!Identifier of the TaskEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
TaskRecurrenceOrderByNestedInput input 15 fields: id, isDeleted, modified, …

Sorting by a field of the related TaskRecurrence record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
dayOrderByEnumField whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
dayOfWeekOrderByEnumBit Flag field, with limited combination of integer values.
endDateOrderByEnumDate information. The last date when no more other items should be created.
monthOrderByEnumField whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
occurEveryOrderByEnumThe number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
occurrencesCountOrderByEnumWhole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
startDateOrderByEnumDate information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
taskIdOrderByEnumId of the parent task.
typeOrderByEnumRecurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
weekOrderByEnumField whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
revisionOrderByEnumRevision when entity was lastly changed.
TaskReminderOrderByNestedInput input 9 fields: id, isDeleted, modified, …

Sorting by a field of the related TaskReminder record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
ownerIdOrderByEnumId of the user who set the reminder.
setDateOrderByEnumTimestamp when the reminder should fire.
statusOrderByEnumCurrent state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
taskIdOrderByEnumId of the task this reminder belongs to.
revisionOrderByEnumRevision when entity was lastly changed.
UpdateTaskInput input 39 fields: clientMutationId, id, mediaTranscriptionId, …

Id of a Task record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
mediaTranscriptionIdUUIDId of the linked Media record holding the activity's call recording / transcription, when available.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
activityTypeIdIDId of the task type.
callDurationIntDuration of the recorded call. Set automatically when the task is linked to a call log.
callIdIDId of the linked call record.
callOutcomeIdIDId of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer).
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this task.
descriptionStringFree-form description of what the task entails.
dueDateDateDate by which the task is expected to be completed.
durationFloatEstimated duration of the task. Stored as a duration value (days/hours/minutes).
ownerIdIDId of the task owner.
priorityPriorityEnumPriority level of the task: Low, Medium or High.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateDateDate when work on the task is scheduled to begin.
statusTaskStatusEnumCurrent status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done.
subjectStringShort summary line shown in lists and notifications.
unitIdIDId of the sales unit.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
sharingUnits[CreateTaskSharingSalesUnitRelationNoTaskBackrefInput!]Sales units that have been granted shared access to this task. Editable only when shareMode allows unit sharing.
sharingClients[CreateTaskSharingClientRelationNoTaskBackrefInput!]Users that have been granted shared access to this task. Editable only when shareMode allows user sharing.
accountRelations[CreateActivityRelationNoActivityBackrefInput!]Accounts this task is linked to.
contactRelations[CreateActivityRelationNoActivityBackrefInput!]Contacts this task is linked to.
leadRelations[CreateActivityRelationNoActivityBackrefInput!]Leads this task is linked to.
opportunityRelations[CreateActivityRelationNoActivityBackrefInput!]Opportunities this task is linked to.
projectRelations[CreateActivityRelationNoActivityBackrefInput!]Projects this task is linked to, including the per-objective ordering.
quoteRelations[CreateActivityRelationNoActivityBackrefInput!]Quotes this task is linked to.
customEntityRelations[CreateActivityRelationNoActivityBackrefInput!]Custom entity records this task is linked to.
exchangeEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdStringExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
taskRecurrenceUpdateTaskRecurrenceNoTaskBackrefInputRecurrence schedule generating periodic copies of this task, or empty when no recurrence is set up.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this task.
comments[CreateActivityCommentNoActivityBackrefInput!]Comments authored on this task.
tags[CreateTagRelationNoTaskBackrefInput!]Tag labels applied to this task.
callSidStringIdentifier (SID) of a phone call made through Coevera calling, to attach that call to the task; null detaches the call. Write-only.
UpdateTaskRecurrenceNoTaskBackrefInput input 13 fields: applyRecurrence, modified, created, …

Id of a TaskRecurrence record and the field values to change, updated together with the record it belongs to.

Input fieldTypeDescription
applyRecurrenceBooleanDefault true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
dayDateDayEnumField whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
dayOfWeekIntBit Flag field, with limited combination of integer values.
endDateDateDate information. The last date when no more other items should be created.
monthDateMonthEnumField whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
occurEveryIntThe number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
occurrencesCountIntWhole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
startDateDateDate information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
typeRecurrenceTypeEnumRecurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
weekDateWeekEnumField whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
revisionIntRevision when entity was lastly changed.
UpdateTaskReminderNoTaskBackrefInput input 6 fields: modified, created, ownerId, …

Id of a TaskReminder record and the field values to change, updated together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
ownerIdIDId of the user who set the reminder.
setDateDateTimeTimestamp when the reminder should fire.
statusReminderStatusEnumCurrent state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
revisionIntRevision when entity was lastly changed.
BulkUpdateTaskPayload object result: BulkUpdateResults!

Result of the bulkUpdateTask mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
ChangeOwnershipTaskPayload object result: TaskEntity, clientMutationId: String

Result of the changeOwnershipTask mutation.

FieldTypeDescription
resultTaskEntityThe task with its new owner.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ConvertTaskPayload object task: TaskEntity!, clientMutationId: String

Result of the convertTask mutation.

FieldTypeDescription
taskTaskEntity!The created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateTaskPayload object task: TaskEntity, clientMutationId: String

Result of the createTask mutation.

FieldTypeDescription
taskTaskEntityThe created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
DeleteTaskPayload object task: TaskEntity, clientMutationId: String

Result of the deleteTask mutation.

FieldTypeDescription
taskTaskEntityThe deleted record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ManageSharingTaskPayload object result: TaskEntity, clientMutationId: String

Result of the manageSharingTask mutation.

FieldTypeDescription
resultTaskEntityThe record with its updated sharing.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ReleaseOwnershipTaskPayload object result: TaskEntity, clientMutationId: String

Result of the releaseOwnershipTask mutation.

FieldTypeDescription
resultTaskEntityThe released task.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RemoveReminderTaskPayload object result: TaskEntity, clientMutationId: String

Result of the removeReminderTask mutation.

FieldTypeDescription
resultTaskEntityThe task with the dismissed reminder.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreTaskPayload object result: TaskEntity, clientMutationId: String

Result of the restoreTask mutation.

FieldTypeDescription
resultTaskEntityThe restored record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
SetReminderTaskPayload object result: TaskEntity, clientMutationId: String

Result of the setReminderTask mutation.

FieldTypeDescription
resultTaskEntityThe task with the updated reminder.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
SetTaskStatusPayload object result: TaskEntity, clientMutationId: String

Result of the setTaskStatus mutation.

FieldTypeDescription
resultTaskEntityThe updated task.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateTaskPayload object task: TaskEntity, clientMutationId: String

Result of the updateTask mutation.

FieldTypeDescription
taskTaskEntityThe updated record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
PriorityEnum enum Low, Medium, High

Priority of a task.

ValueDescription
LowLow priority.
MediumMedium priority.
HighHigh priority.
TaskAutoPrefill object entity: TaskEntity, fieldIds: [UUID!]!

New, unsaved task pre-filled by AI or from an email conversation, with the ids of the fields that were filled in.

FieldTypeDescription
entityTaskEntityNew task carrying the pre-filled values; it is not saved.
fieldIds[UUID!]!Ids of the fields that were filled in.
TaskStatusEnum enum NotStarted, InProgress, Waiting, Completed, Deferred

Status of a task.

ValueDescription
NotStartedWork on the task has not started.
InProgressThe task is being worked on.
WaitingThe task is waiting on someone or something else.
CompletedThe task is done.
DeferredThe task has been postponed.