Read a task.
|
id
globally unique identifier
Required
Guid ID of the task to be read. |
|
tz
string
Optional parameter to set time zone information. |
None.
|
ID
globally unique identifier
Required on Update
ID of the Task. |
|
AncestorID
globally unique identifier
Required on Create
ID of the ancestor for a task; department, organization, or individual. |
|
ParentID
globally unique identifier
ID of the project above a task. |
|
Name
string
Required
Name of the task. (Max length 255 characters) |
|
Description
string
Description of the task. |
|
Priority
integer
Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null. |
|
Rank
integer
Rank of the task. |
|
Color
string
Hex value for the color of the given task. |
|
HoursActual
decimal number
Number of actual hours this task took. |
|
HoursProjected
decimal number
Number of hours this task is projected to take. |
|
StartDateActual
string
Date this task was actually started. |
|
StartDateProjected
string
Date this task is projected to start. |
|
EndDateActual
string
Date this task was completed. |
|
EndDateProjected
string
Date this task is projected to complete. |
|
Milestone
boolean
Displays if this task is a milestone or not. |
|
TrackingLabel
string
Customizable label for task. (Max length 50 characters) |
|
NearHighlightOverride
integer
Override the near due date highlights settings for a specific task. |
|
SiteID
globally unique identifier
ReadOnly
ID of the site for the task. |
|
RankPath
Collection of byte
ReadOnly
Current rank of the given task in a byte array. |
|
RankOrder
string
ReadOnly
RankOrder to sort rank in the format .0001.0001.0001 (This always returns null when reading a single task by ID.) |
|
DisplayRank
string
ReadOnly
Rank that is displayed |
|
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 (This always returns null when reading a single task by ID.) |
|
SumHoursActual
decimal number
ReadOnly
Sum of the actual number of hours this task took. |
|
SumHoursProjected
decimal number
ReadOnly
Sum of the number of hours this task is projected to take. |
|
Deleted
boolean
ReadOnly
Deleted status of the task. |
|
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the task. |
|
Created
date
ReadOnly
Date the task was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the task. |
|
Updated
date
ReadOnly
Date when the task was last updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that updated the task. |
|
PeopleResponsible
string
ReadOnly
Names of the People responsible for this task. |
|
PeopleResponsibleList
Collection of PersonResponsible
ReadOnly
List and details of all the people responsible for the given task. |
|
LastComment
string
ReadOnly
Body of the most recent comment for the given task. |
|
LastCommentDate
date
ReadOnly
Date of the most recent comment for the given task. |
|
LastCommentByID
globally unique identifier
ReadOnly
ID of the individual who posted the most recent comment for the given task. |
|
LastCommentBy
string
ReadOnly
Name of the individual who posted the most recent comment for the given task. |
|
Draft
boolean
ReadOnly
Displays if this task is a draft or not. |
|
RowType
integer
ReadOnly
Row type of the task. |
|
AncestorType
byte
ReadOnly
Row type of the Ancestor. |
|
AncestorName
string
ReadOnly
Name of the task's Ancestor. |
|
ColorName
string
ReadOnly
Name of the task's color. |
|
ColorRank
integer
ReadOnly
Rank of the task's color. |
|
EndDate
string
ReadOnly
Date the task actually ended or projected to end. |
|
StartDate
string
ReadOnly
Date the task actually started or projected to start. |
|
NearHighlight
integer
ReadOnly
Near due date highlights settings for a specific task. |
|
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
|
IsRecurring
boolean
This denotes if the task will reoccur when it is completed. |
|
Interval
integer
Interval of the recurring task. |
|
IntervalQualifier
string
Interval type for the task. This can be: Day, Month, Week, or Year |
|
MonthOption
boolean
If it is monthly ex 2nd tuesday |
|
DayOfMonth
byte
Sets day of the month the task should reoccur |
|
WeekDayInstance
byte
1-5 Tuesday |
|
WeekDay
byte
Day of the week. |
|
Sunday
boolean
Denotes if this task should repeat on Sunday. |
|
Monday
boolean
Denotes if this task should repeat on Monday. |
|
Tuesday
boolean
Denotes if this task should repeat on Tuesday. |
|
Wednesday
boolean
Denotes if this task should repeat on Wednesday. |
|
Thursday
boolean
Denotes if this task should repeat on Thursday. |
|
Friday
boolean
Denotes if this task should repeat on Friday. |
|
Saturday
boolean
Denotes if this task should repeat on Saturday. |
|
PreviousTask
globally unique identifier
ReadOnly
ID of the previous task. |
|
NextTask
globally unique identifier
ReadOnly
ID of the next task. Recurrence can no longer be set if this is not null. |
|
NewPeople
string
List of comma separated GUID Individual IDs to add to a new task. |
<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
<ID>af788b8d-2304-4e47-a4f1-6a02dcf1f586</ID>
<AncestorID>4d1d77ff-f40e-46dd-9272-e234b06d8d1b</AncestorID>
<ParentID>4d3099ab-4fa1-4cfe-ab7b-4581b4d43d58</ParentID>
<Name>sample string 1</Name>
<Description>sample string 2</Description>
<Priority>1</Priority>
<Rank>1</Rank>
<Color>sample string 3</Color>
<HoursActual>1</HoursActual>
<HoursProjected>1</HoursProjected>
<Milestone>true</Milestone>
<TrackingLabel>sample string 8</TrackingLabel>
<NearHighlightOverride>1</NearHighlightOverride>
<SiteID>dbcca153-bab5-4c43-aabb-c50c399850fb</SiteID>
<RankPath>QEA=</RankPath>
<RankOrder>sample string 9</RankOrder>
<DisplayRank>sample string 10</DisplayRank>
<Level>1</Level>
<SumHoursActual>1</SumHoursActual>
<SumHoursProjected>1</SumHoursProjected>
<Deleted>true</Deleted>
<DeletedByRef>true</DeletedByRef>
<Created>2026-03-08T09:26:06.7235007+00:00</Created>
<CreatedBy>8b68ca60-829a-4df8-b2c3-7260ff6472e8</CreatedBy>
<Updated>2026-03-08T09:26:06.7235007+00:00</Updated>
<UpdatedBy>a6f52ddb-38db-4000-93d0-04b762178d14</UpdatedBy>
<PeopleResponsible>sample string 11</PeopleResponsible>
<PeopleResponsibleList>
<PersonResponsible>
<TaskID>92342f08-0b3d-4403-9157-1d6df7f6267a</TaskID>
<IndividualID>c7319414-215a-45c2-bbbd-061407ea5534</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>f6c6cd73-c295-4db2-9969-d2df579a6de3</ID>
<TaskIndividualGroupID>e9bfa8be-5826-43f3-b474-68007d8529e6</TaskIndividualGroupID>
<Created>2026-03-08T09:26:06.7235007+00:00</Created>
<CreatedBy>8b56e862-50da-49da-ba05-83fc05d71514</CreatedBy>
<SiteID>7f358a7d-0d31-4f41-bb2f-fa7b61818e8d</SiteID>
<Updated>2026-03-08T09:26:06.7235007+00:00</Updated>
<UpdatedBy>3c33250a-1665-41af-85e4-9555591daf15</UpdatedBy>
<HoursActualRollup>1</HoursActualRollup>
<HoursProjectedRollup>1</HoursProjectedRollup>
<FullName>sample string 1</FullName>
</PersonResponsible>
<PersonResponsible>
<TaskID>92342f08-0b3d-4403-9157-1d6df7f6267a</TaskID>
<IndividualID>c7319414-215a-45c2-bbbd-061407ea5534</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>f6c6cd73-c295-4db2-9969-d2df579a6de3</ID>
<TaskIndividualGroupID>e9bfa8be-5826-43f3-b474-68007d8529e6</TaskIndividualGroupID>
<Created>2026-03-08T09:26:06.7235007+00:00</Created>
<CreatedBy>8b56e862-50da-49da-ba05-83fc05d71514</CreatedBy>
<SiteID>7f358a7d-0d31-4f41-bb2f-fa7b61818e8d</SiteID>
<Updated>2026-03-08T09:26:06.7235007+00:00</Updated>
<UpdatedBy>3c33250a-1665-41af-85e4-9555591daf15</UpdatedBy>
<HoursActualRollup>1</HoursActualRollup>
<HoursProjectedRollup>1</HoursProjectedRollup>
<FullName>sample string 1</FullName>
</PersonResponsible>
</PeopleResponsibleList>
<LastComment>sample string 12</LastComment>
<LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-03-08T09:26:06.7235007Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</LastCommentDate>
<LastCommentByID>79bdf632-e76d-4a4b-aa4b-a7c5a8549f3e</LastCommentByID>
<LastCommentBy>sample string 13</LastCommentBy>
<Draft>true</Draft>
<RowType>1</RowType>
<AncestorType>64</AncestorType>
<AncestorName>sample string 14</AncestorName>
<ColorName>sample string 15</ColorName>
<ColorRank>1</ColorRank>
<NearHighlight>1</NearHighlight>
<CanRead>true</CanRead>
<CanUpdate>true</CanUpdate>
<CanDelete>true</CanDelete>
<CanDelegate>true</CanDelegate>
<IsRecurring>true</IsRecurring>
<Interval>1</Interval>
<IntervalQualifier>sample string 19</IntervalQualifier>
<MonthOption>true</MonthOption>
<DayOfMonth>64</DayOfMonth>
<WeekDayInstance>64</WeekDayInstance>
<WeekDay>64</WeekDay>
<Sunday>true</Sunday>
<Monday>true</Monday>
<Tuesday>true</Tuesday>
<Wednesday>true</Wednesday>
<Thursday>true</Thursday>
<Friday>true</Friday>
<Saturday>true</Saturday>
<PreviousTask>4473d282-18b4-4193-a48f-48a68452b9c1</PreviousTask>
<NextTask>0decbed1-0893-4b3e-a493-2b45f61437fc</NextTask>
<NewPeople>sample string 27</NewPeople>
</Task>
{
"ID": "af788b8d-2304-4e47-a4f1-6a02dcf1f586",
"AncestorID": "4d1d77ff-f40e-46dd-9272-e234b06d8d1b",
"ParentID": "4d3099ab-4fa1-4cfe-ab7b-4581b4d43d58",
"Name": "sample string 1",
"Description": "sample string 2",
"Priority": 1,
"Rank": 1,
"Color": "sample string 3",
"HoursActual": 1.0,
"HoursProjected": 1.0,
"Milestone": true,
"TrackingLabel": "sample string 8",
"NearHighlightOverride": 1,
"SiteID": "dbcca153-bab5-4c43-aabb-c50c399850fb",
"RankPath": "QEA=",
"RankOrder": "sample string 9",
"DisplayRank": "sample string 10",
"Level": 1,
"SumHoursActual": 1.0,
"SumHoursProjected": 1.0,
"Deleted": true,
"DeletedByRef": true,
"Created": "2026-03-08T09:26:06.7235007+00:00",
"CreatedBy": "8b68ca60-829a-4df8-b2c3-7260ff6472e8",
"Updated": "2026-03-08T09:26:06.7235007+00:00",
"UpdatedBy": "a6f52ddb-38db-4000-93d0-04b762178d14",
"PeopleResponsible": "sample string 11",
"PeopleResponsibleList": [
{
"TaskID": "92342f08-0b3d-4403-9157-1d6df7f6267a",
"IndividualID": "c7319414-215a-45c2-bbbd-061407ea5534",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "f6c6cd73-c295-4db2-9969-d2df579a6de3",
"TaskIndividualGroupID": "e9bfa8be-5826-43f3-b474-68007d8529e6",
"Created": "2026-03-08T09:26:06.7235007+00:00",
"CreatedBy": "8b56e862-50da-49da-ba05-83fc05d71514",
"SiteID": "7f358a7d-0d31-4f41-bb2f-fa7b61818e8d",
"Updated": "2026-03-08T09:26:06.7235007+00:00",
"UpdatedBy": "3c33250a-1665-41af-85e4-9555591daf15",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
},
{
"TaskID": "92342f08-0b3d-4403-9157-1d6df7f6267a",
"IndividualID": "c7319414-215a-45c2-bbbd-061407ea5534",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "f6c6cd73-c295-4db2-9969-d2df579a6de3",
"TaskIndividualGroupID": "e9bfa8be-5826-43f3-b474-68007d8529e6",
"Created": "2026-03-08T09:26:06.7235007+00:00",
"CreatedBy": "8b56e862-50da-49da-ba05-83fc05d71514",
"SiteID": "7f358a7d-0d31-4f41-bb2f-fa7b61818e8d",
"Updated": "2026-03-08T09:26:06.7235007+00:00",
"UpdatedBy": "3c33250a-1665-41af-85e4-9555591daf15",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
}
],
"LastComment": "sample string 12",
"LastCommentDate": "2026-03-08T09:26:06.7235007+00:00",
"LastCommentByID": "79bdf632-e76d-4a4b-aa4b-a7c5a8549f3e",
"LastCommentBy": "sample string 13",
"Draft": true,
"RowType": 1,
"AncestorType": 64,
"AncestorName": "sample string 14",
"ColorName": "sample string 15",
"ColorRank": 1,
"NearHighlight": 1,
"CanRead": true,
"CanUpdate": true,
"CanDelete": true,
"CanDelegate": true,
"IsRecurring": true,
"Interval": 1,
"IntervalQualifier": "sample string 19",
"MonthOption": true,
"DayOfMonth": 64,
"WeekDayInstance": 64,
"WeekDay": 64,
"Sunday": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"PreviousTask": "4473d282-18b4-4193-a48f-48a68452b9c1",
"NextTask": "0decbed1-0893-4b3e-a493-2b45f61437fc",
"NewPeople": "sample string 27"
}