Returns tasks available to the current user and removes time details when the user lacks the related time-tracking access.
Authentication
AuthorizationBearerSend your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.
Query parameters
pageintegerOptional1Page number for pagination
pageSizeintegerOptional10Number of items per page
orderbystringOptionalThe properties to order by
filterbystringOptionalThe filter expression to filter by
Responses
200 OK
application/json
namestringRequired0 maxLength: 1000 The name of the task. Max allowed length: 1000 characters.
descriptionstring or nullOptional0 maxLength: 25000 The description of the task. Max allowed length: 25000 characters.
isPriobooleanOptionalWhether this task is marked as priority.
startOnstring or nullOptionalThe expected start date and time of the task.
dueOnstring or nullOptionalThe expected due date and time of the task.
laneOrderintegerOptionalThe lane order defines the vertical position in the task board.
plannedDurationintegerOptionalThe expected planned workload of the task, in seconds.
idstringOptionalThe Id of the task.
taskNumberinteger or nullOptionalThe sequential task number within the project. Unique within the project, never reused even after deletion.
taskIdentifierstring or nullOptional40 The full task identifier combining project key and task number (e.g., "NIKE-42"). Maintained by the service layer, updated when project key changes.
isExternalbooleanOptionalTrue if the model is coming from an external workspace (awork Connect). False otherwise.
createdViastring or nullOptionalThe origin of the task. From which 'flow' the task was created. Automatically set by the backend.
isHiddenForConnectUsersbooleanOptionalTrue if the task is hidden for external workspace users. False otherwise.
baseTypestringOptionalAllowed: "private" "projecttask"
The base type of the task. Can be 'private' for a private task or 'projecttask' for a project task.
taskStatusIdstringOptionalThe id of the status for this task.
taskStatusobjectOptionalShow 13 properties
idstringOptionalThe primary identifier of this task status.
namestring or nullOptionalThe name of the task status.
typestring or nullOptionalOf what general type is this task status?.
ordernumber or nullOptionalThe order of the task status in a project.
iconstring or nullOptionalThe icon of the task status.
projectIdstring or nullOptionalIs set if the task status is related to a project.
projectTypeIdstring or nullOptionalIs set if the task status is related to a project type.
workflowIdstring or nullOptionalIs set if the task status is related to a workflow.
createdOnstringOptionalThe date this entity was created.
createdBystringOptionalThe id of the user who created this entity.
updatedOnstringOptionalThe date this entity was last modified.
updatedBystringOptionalThe id of the user who last modified this entity.
isExternalbooleanOptionalTrue if the task status is coming from an external workspace (awork Connect).
typeOfWorkIdstringOptionalThe id of the type of work of this task.
typeOfWorkobjectOptionalShow 4 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
iconstring or nullOptionalThe icon of the type.
isArchivedbooleanOptionalWhether the type is archived.
assigneesarray of object or nullOptionalThe list assigned users of this task, or empty if not user was assigned.
Show 8 properties
idstringOptionalThe identifier of the nested model.
firstNamestring or nullOptionalThe first name of the user.
lastNamestring or nullOptionalThe last name of the user.
hasImageboolean or nullOptionalWhether this user has a profile image.
plannedEffortintegerOptionalThe planned effort of the user assigned to the task, in seconds.
isDistributedPlannedEffortbooleanOptionalIf the PlannedEffort was calculated as distributed effort.
updatedOnstringOptionalThe date this task assignee was last modified.
isExternalbooleanOptionalTrue if the model is coming from an external workspace (awork Connect). False otherwise.
projectIdstring or nullOptionalThe id of the project this task is assigned to. Only set if this is a project task. In this case, it is equal to the EntityId.
projectobjectOptionalShow 16 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
projectKeystring or nullOptionalThe unique project key within the workspace (e.g., "NIKE"). Maximum 32 characters, uppercase letters, numbers, and dashes only.
projectStatusobjectOptionalShow 5 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
descriptionstring or nullOptionalThe description of the type.
typestring or nullOptionalThe type of the status.
isArchivedbooleanOptionalWhether the type is archived.
companyobjectOptionalShow 4 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
hasImagebooleanOptionalWhether the company has a profile image.
descriptionstring or nullOptionalThe description of the company.
companyIdstring or nullOptionalThe companyId of the project.
projectTypeobjectOptionalShow 4 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
iconstring or nullOptionalThe icon of the type.
isArchivedbooleanOptionalWhether the type is archived.
hasImagebooleanOptionalWhether the project has an image.
isPrivatebooleanOptionalWhether the project is private.
isBillableByDefaultboolean or nullOptionalWhether the project is billable by default.
membersarray of object or nullOptionalThe list of all members of the project.
Show 6 properties
idstringOptionaluserIdstringOptionalprojectRoleIdstringOptionalprojectRoleNamestring or nullOptionalisResponsiblebooleanOptionalisExternalbooleanOptionalTrue if the model is coming from an external workspace (awork Connect). False otherwise.
colorstring or nullOptionalThe color of the project for display purposes in awork. Can be null when no color assigned.
createdBystringOptionalThe created by of the project.
teamsarray of object or nullOptionalThe ids of the team the project is associated to.
Show 1 properties
idstringOptionalcustomFieldsarray of object or nullOptionalCustom fields of the project.
Show 9 properties
customFieldDefinitionIdstringOptionalThe custom field definition id.
userIdValuestring or nullOptionalThe the user id value.
clientIdValuestring or nullOptionalThe client id value.
numberValuenumber or nullOptionalThe number value.
selectionOptionIdValuestring or nullOptionalThe selection option id value.
selectionOptionobjectOptionalShow 4 properties
idstringOptionalThe id of the custom field selection option.
valuestringRequired1 The selection value which can be later used in a select custom field.
colorstring or nullOptionalAllowed: "red" "orange" "yellow" "green" "cyan" "blue" "indigo" "purple" "steel"
The color of the selection option.
ordernumberOptionalThe order of the custom field selection option.
textValuestring or nullOptionalThe text value.
dateValuestring or nullOptionalThe date value.
booleanValueboolean or nullOptionalThe boolean value.
isExternalbooleanOptionalTrue if the model is coming from an external workspace (awork Connect). False otherwise.
correlationIdstringOptionalThe correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.
parentIdstring or nullOptionalThe id of the parent task this of this subtask. Only set if this is a subtask.
parentTaskobjectOptionalShow 5 properties
idstringOptionalThe identifier of the nested model.
namestring or nullOptionalThe name of the entity.
createdBystringOptionalThe id of the user who created this task.
userIdstring or nullOptionalThe id of the user of the private task. Null for project tasks.
assigneeIdsarray of string or nullOptionalList of assignee user ids of this task.
isSubtaskbooleanOptionalTrue if the task is a subtask.
numberOfSubtasksinteger or nullOptionalThe number of subtasks of this task. Null if it's not a parent task.
hasAttachmentbooleanOptionalWhether this task has an attachment.
listsarray of object or nullOptionalThe lists to which the task is assigned to.
Show 13 properties
idstringOptionalThe id of the task list.
createdOnstringOptionalThe date this task list was created.
createdBystringOptionalThe id of the user who created this task list.
updatedOnstringOptionalThe date this task list was last modified.
updatedBystringOptionalThe id of the user who last modified this task list.
namestring or nullOptionalThe name of the list.
ordernumber or nullOptionalThe order of the list.
plannedDurationinteger or nullOptionalThe planned duration for this task list, in seconds.
totalPlannedDurationinteger or nullOptionalThe total planned duration for this task list, including all primary tasks (parent tasks which have this tacklist as PrimaryTaskListId), in seconds. Calculated: sum PlannedDuration of primary tasks in list Archived task lists are not included in the calculation.
totalPlannedDurationWithHierarchyinteger or nullOptionalThe total planned duration for this task list, including all primary tasks (parent tasks which have this task list as PrimaryTaskListId), in seconds. Calculated: max(PlannedDuration, sum TotalPlannedDurationWithHierarchy of primary tasks in list) Archived task lists are not included in the calculation.
isArchivedbooleanOptionalWhether the task list has been archived.
isHiddenForConnectUsersbooleanOptionalTrue if the task in this list will be not visible for external workspace users. False otherwise.
orderOfTasknumber or nullOptionalThe order of the task in the list.
entityIdstring or nullOptionalDeprecatedThe id of the entity this task is assigned to. This is the id of the project if this is a project task, or the id of a user if this is a private task. See 'BaseType' for supported types.
userIdstring or nullOptionalThe id of the user of the private task.
tagsarray of object or nullOptionalThe list of tags.
Show 3 properties
idstringOptionalnamestring or nullOptionalThe name of the tag.
colorstring or nullOptionalThe color of the tag.
createdOnstringOptionalThe date this task was created.
createdBystringOptionalThe id of the user who created this task.
updatedOnstringOptionalThe date this task was last modified.
updatedBystringOptionalThe id of the user who last modified this task.
closedOnstring or nullOptionalThe date the task was set to closed.
closedBystring or nullOptionalThe user who closed the task.
ordernumberOptionalThe order of the task in a task status column.
subtaskOrdernumber or nullOptionalThe order of the subtask relative to its parent task.
createdFromTaskIdstring or nullOptionalWhen the task was created by a recurrency rule, the id is the link to the template of which the task was created.
isRecurringbooleanOptionalIf the task is a recurrency template (used to create new tasks by a recurrency rule), the flag is true.
customFieldsarray of object or nullOptionalCustom fields of the task.
Show 9 properties
customFieldDefinitionIdstringOptionalThe custom field definition id.
userIdValuestring or nullOptionalThe the user id value.
clientIdValuestring or nullOptionalThe client id value.
numberValuenumber or nullOptionalThe number value.
selectionOptionIdValuestring or nullOptionalThe selection option id value.
selectionOptionobjectOptionalShow 4 properties
idstringOptionalThe id of the custom field selection option.
valuestringRequired1 The selection value which can be later used in a select custom field.
colorstring or nullOptionalAllowed: "red" "orange" "yellow" "green" "cyan" "blue" "indigo" "purple" "steel"
The color of the selection option.
ordernumberOptionalThe order of the custom field selection option.
textValuestring or nullOptionalThe text value.
dateValuestring or nullOptionalThe date value.
booleanValueboolean or nullOptionalThe boolean value.
deriveDatesFromSubtasksbooleanOptionalWhen true, if the task is a parent task, the StartOn and DueOn will be automatically adjusted to the start and due date of the subtasks.
trackedDurationinteger or nullOptionalThe summed up duration of all time trackings directly on this task (excluding subtasks).
totalTrackedDurationinteger or nullOptionalThe summed up duration of all time trackings for this task, including subtasks.
totalPlannedDurationinteger or nullOptionalThe total planned workload of the task, in seconds, including subtasks.
resourceVersionintegerOptionalThe version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
checklistItemsDoneCountintegerOptionalThe number of checklist items marked as done.
checklistItemsCountintegerOptionalThe total number of checklist items.
taskSchedulesCountintegerOptionalThe number of task schedules for this task.
isCompletelyScheduledbooleanOptionalWhether this task is completed scheduled.
commentCountintegerOptionalThe number of comments on this task.