Task object representation

The task object representation and fields are described below.

task was introduced in API version V1

task has not been marked for deprecation

Usages

Task

Description

Representation of a task with references to associated concepts as well as baseline fields for managing tasks

Example create representation

{
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "assignee" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "project" : {
    "urn" : "4c5b4343-e8aa-42a5-839e-04c0a7405a18",
    "url" : "/n/v1/project/4c5b4343-e8aa-42a5-839e-04c0a7405a18"
  },
  "status" : "PENDING",
  "priority" : "CRITICAL",
  "title" : "Welcome your new customer",
  "description" : "There is a new customer so it's time to say Hi...",
  "createdTimestamp" : "2025-09-13T17:08:00",
  "updatedTimestamp" : "2025-09-10T17:08:00",
  "dueTimestamp" : "2025-09-13T17:08:00",
  "blockedBy" : [ ],
  "blocking" : [ ],
  "associatedTasks" : [ ],
  "associatedEntities" : [ ],
  "associatedIdentities" : [ {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  } ],
  "associatedCompanies" : [ {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  } ]
}

Example response representation

{
  "urn" : "365550cd-612b-4593-b4c5-ec30f25fc04d",
  "url" : "/n/v1/task/365550cd-612b-4593-b4c5-ec30f25fc04d",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "assignee" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "project" : {
    "urn" : "4c5b4343-e8aa-42a5-839e-04c0a7405a18",
    "url" : "/n/v1/project/4c5b4343-e8aa-42a5-839e-04c0a7405a18"
  },
  "status" : "PENDING",
  "priority" : "CRITICAL",
  "title" : "Welcome your new customer",
  "description" : "There is a new customer so it's time to say Hi...",
  "createdTimestamp" : "2025-09-13T17:08:00",
  "updatedTimestamp" : "2025-09-10T17:08:00",
  "dueTimestamp" : "2025-09-13T17:08:00",
  "blockedBy" : [ ],
  "blocking" : [ ],
  "associatedTasks" : [ ],
  "associatedEntities" : [ ],
  "associatedIdentities" : [ {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  } ],
  "associatedCompanies" : [ {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  } ]
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN of this task
url	URL represented as a string	The URL for accessing this task
owner	company	The owning company for this task
workflowStage	workflowstage	The workflow stage of this task if set otherwise not set
assignee	identity	The assignee for the task
project	project	The project this task is associated with
status	A string representation of a enumeration name restricted to the documented values	The status of the task	Allowed values: UNDEFINED PENDING IN_PROGRESS BLOCKED COMPLETED CLOSED UNRECOGNIZED
priority	A string representation of a enumeration name restricted to the documented values	The priority of the task	Allowed values: NONE LOW MEDIUM HIGH CRITICAL UNRECOGNIZED
title	String literal	The title of the task	Required on create. Maximum length: 1024.
description	String literal	The descriptive body for the task as a string.	Required on create. Maximum length: 65536.
createdTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The creation timestamp of the task
updatedTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The updated timestamp of the task
dueTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp of the task's due date	Required on create.
blockedBy	task[]	The tasks which are marked as blocking this task which is blocked by them	Required on create.
blocking	task[]	The tasks which are blocked by this task	Required on create.
associatedTasks	task[]	Associated tasks used to capture references and relations between this task and other related tasks	Required on create.
associatedEntities	entity[]	Entities associated with this task used for tasks like reviewing an entity content before publication	Required on create.
associatedIdentities	identity[]	Identities associated with this task used for tasks like reviewing an identity associated with a new contact	Required on create.
associatedCompanies	company[]	Companies associated with this task used for tasks like reviewing a new company details when a company is created	Required on create.
identityForLogs	identity	An identity reference which is used to attribute changes when writing task activities e.g. a manager changing the status of a task from UNDEFINED to HIGH. The identity will be used to track who made the change in the activity log but won't appear in the assignees. If none is provided the activity logs will not be attributed