Read all projects for the currently logged in user.
deleted
byte
Add ?deleted=0, 1, or 2 for not deleted, deleted, or all. |
tz
string
Optional parameter to set time zone information. |
None.
ID
globally unique identifier
Required on Update
ID of the project. |
ParentID
globally unique identifier
ID of the parent. |
AncestorID
globally unique identifier
Required
Ancestor ID of the project; organization or department.. |
Rank
integer
Rank of the project. |
Color
string
Hex value of the color for the project. (Max length 6 characters) |
HoursActual
decimal number
(Deprecated) Number of hours this project actually took to complete. |
HoursProjected
decimal number
(Deprecated) Number of hours this project is projected to take. |
StartDateActual
string
Actual start date of the project. |
StartDateProjected
string
Projected start date of the project. |
EndDateActual
string
Date the project actually ended. |
EndDateProjected
string
Date the project is projected to end. |
TrackingLabel
string
Customizable label for project. |
NearHighlightOverride
integer
Near due highlight settings for a given project that have been overridden at the project level. |
Name
string
Name of the given project. (Max length 255 characters) |
Description
string
Description of the project. |
StatusID
integer
ID of the status linked to this project. |
PhaseID
integer
Required
ID of the phase linked to this project. |
AncestorName
string
ReadOnly
Ancestor Name of the project; department or organization. |
RankOrder
string
ReadOnly
RankOrder to sort rank in the format .0001.0001.0001 |
DisplayRank
string
ReadOnly
Rank that is displayed |
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 |
SumHoursActual
decimal number
ReadOnly
Sum of all the hours spent on this project. |
SumHoursProjected
decimal number
ReadOnly
Sum of the projected number of hours to be spent on this project. |
Status
string
ReadOnly
Name of the status linked to this project. |
Phase
string
ReadOnly
Name of the phase linked to this project. |
Deleted
boolean
ReadOnly
Deleted status of this project. |
DeletedByRef
boolean
ReadOnly
Deleted by reference status of this project. |
Created
string
ReadOnly
Date the project was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the project. |
Updated
date
ReadOnly
Date the given project was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that last updated the given project. |
TeamMembers
string
ReadOnly
Individuals assigned to the project as team members. |
LastComment
string
ReadOnly
Last comment made on this project. |
LastCommentDate
date
ReadOnly
Date the last comment was made. |
LastCommentByID
globally unique identifier
ReadOnly
ID of the person that made the last comment. |
LastCommentBy
string
ReadOnly
Name of the person that last commented. |
EndDateChanges
integer
ReadOnly
Number of times the end date has changed for the project. |
IncludeSurveys
boolean
ReadOnly
Parameter to include or omit surveys. |
AncestorType
integer
ReadOnly
AncestorType of the project. |
Draft
boolean
Indicates if the given project is a draft, this defaults to false. (drafts are unfinished projects that are only visible to the person that created them and not public). |
LinkedToID
globally unique identifier
ReadOnly
ID of the linked project. |
TeamMemberList
Collection of TeamMember
ReadOnly
List and details of Team Members for a given project. |
StatusName
string
ReadOnly
Name of the status for the given project. |
StatusRank
integer
ReadOnly
Rank of the status for the given project. |
PhaseName
string
ReadOnly
Name of the phase for the given project. |
PhaseRank
integer
ReadOnly
Rank of the phase for the given project. |
ColorName
string
ReadOnly
Name of the color for the given project. |
ColorRank
integer
ReadOnly
Rank of the color for the given project. |
LinkedAncestorID
globally unique identifier
ReadOnly
Ancestor ID of the linked project. |
LinkedToName
string
ReadOnly
Name of the linked project. |
LinkedToRowType
integer
ReadOnly
RowType of the linked project. |
LinkedAncestorName
string
ReadOnly
Name of the linked Ancestor. |
EndDate
string
ReadOnly
Actual end date of the project, if it is not set then projected end date of the project. |
StartDate
string
ReadOnly
Actual start date of the project, if it is not set then the projected start date of the given project. |
RowType
integer
ReadOnly
Row type of the given project. |
RankPath
Collection of byte
ReadOnly
Current rank of the given project in a byte array. |
OnTime
boolean
ReadOnly
Indicates the on time status of the project, by comparing the actual and projected end dates. |
CanRead
boolean
ReadOnly
Read permission of the given project for the currently logged in individual. |
CanUpdate
boolean
ReadOnly
Update permission of the given project for the currently logged in individual. |
CanDelete
boolean
ReadOnly
Delete permission of the given project for the currently logged in individual. |
CanDelegate
boolean
ReadOnly
Delegate permission of the given project for the currently logged in individual. |
NearHighlight
integer
Required
Near due highlight settings for a given project that have not been overridden. |
<Project xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>88cb3375-bc16-4237-98cc-1091af2c9943</ID> <ParentID>241e88d1-18fb-4b17-aa71-c681372da196</ParentID> <AncestorID>b4dd1e1b-3302-42b4-a2b9-85468760ce5d</AncestorID> <Rank>1</Rank> <Color>sample string 1</Color> <HoursActual>1</HoursActual> <HoursProjected>1</HoursProjected> <TrackingLabel>sample string 6</TrackingLabel> <NearHighlightOverride>1</NearHighlightOverride> <Name>sample string 7</Name> <Description>sample string 8</Description> <StatusID>1</StatusID> <PhaseID>1</PhaseID> <AncestorName>sample string 9</AncestorName> <RankOrder>sample string 10</RankOrder> <DisplayRank>sample string 11</DisplayRank> <Level>1</Level> <SumHoursActual>1</SumHoursActual> <SumHoursProjected>1</SumHoursProjected> <Status>sample string 12</Status> <Phase>sample string 13</Phase> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Created>sample string 14</Created> <CreatedBy>d7d02722-24b3-4bef-82fe-2cc91c339793</CreatedBy> <Updated>2025-09-11T02:54:43.770407+00:00</Updated> <UpdatedBy>d732753c-5771-4ca1-861a-1d8798e48879</UpdatedBy> <TeamMembers>sample string 15</TeamMembers> <LastComment>sample string 16</LastComment> <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-09-11T02:54:43.770407Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>1c88acc3-e1fb-4869-a6ba-154d3cdad0d9</LastCommentByID> <LastCommentBy>sample string 17</LastCommentBy> <EndDateChanges>1</EndDateChanges> <IncludeSurveys>true</IncludeSurveys> <AncestorType>1</AncestorType> <Draft>true</Draft> <LinkedToID>1ee91fa8-a9ad-4546-a31a-2dd0e5a9cabd</LinkedToID> <TeamMemberList> <TeamMember> <TaskID>46a77c25-e36c-4097-9268-c551687efbff</TaskID> <IndividualID>71df5fed-ec60-452a-be36-19fc7e37b627</IndividualID> <RoleID>7922ea47-63ee-407d-8cba-d89a30eeddaa</RoleID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>2e00962f-72e9-4588-b983-045d73faa782</ID> <RoleName>sample string 1</RoleName> <HoursActualRollup>1</HoursActualRollup> <HoursProjectedRollup>1</HoursProjectedRollup> <IndividualFullName>sample string 2</IndividualFullName> <Created>2025-09-11T02:54:43.770407+00:00</Created> <CreatedBy>b0d2b29e-5de0-456c-9a4f-1eaff91f8751</CreatedBy> <SiteID>4053521d-99b5-407f-a362-9714b6ec4498</SiteID> <Updated>2025-09-11T02:54:43.770407+00:00</Updated> <UpdatedBy>11948350-bf16-4f19-baf0-3cb8e4afc937</UpdatedBy> <IndividualFullOrderedName>sample string 3</IndividualFullOrderedName> <RoleDescription>sample string 4</RoleDescription> <TeamSurvey>true</TeamSurvey> </TeamMember> <TeamMember> <TaskID>46a77c25-e36c-4097-9268-c551687efbff</TaskID> <IndividualID>71df5fed-ec60-452a-be36-19fc7e37b627</IndividualID> <RoleID>7922ea47-63ee-407d-8cba-d89a30eeddaa</RoleID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>2e00962f-72e9-4588-b983-045d73faa782</ID> <RoleName>sample string 1</RoleName> <HoursActualRollup>1</HoursActualRollup> <HoursProjectedRollup>1</HoursProjectedRollup> <IndividualFullName>sample string 2</IndividualFullName> <Created>2025-09-11T02:54:43.770407+00:00</Created> <CreatedBy>b0d2b29e-5de0-456c-9a4f-1eaff91f8751</CreatedBy> <SiteID>4053521d-99b5-407f-a362-9714b6ec4498</SiteID> <Updated>2025-09-11T02:54:43.770407+00:00</Updated> <UpdatedBy>11948350-bf16-4f19-baf0-3cb8e4afc937</UpdatedBy> <IndividualFullOrderedName>sample string 3</IndividualFullOrderedName> <RoleDescription>sample string 4</RoleDescription> <TeamSurvey>true</TeamSurvey> </TeamMember> </TeamMemberList> <StatusName>sample string 18</StatusName> <StatusRank>1</StatusRank> <PhaseName>sample string 19</PhaseName> <PhaseRank>1</PhaseRank> <ColorName>sample string 20</ColorName> <ColorRank>1</ColorRank> <LinkedAncestorID>1898f38f-4d14-40a5-8ff5-7953ff66e6f9</LinkedAncestorID> <LinkedToName>sample string 21</LinkedToName> <LinkedToRowType>1</LinkedToRowType> <LinkedAncestorName>sample string 22</LinkedAncestorName> <RowType>1</RowType> <RankPath>QEA=</RankPath> <OnTime>true</OnTime> <CanRead>true</CanRead> <CanUpdate>true</CanUpdate> <CanDelete>true</CanDelete> <CanDelegate>true</CanDelegate> <NearHighlight>1</NearHighlight> </Project>
{ "ID": "88cb3375-bc16-4237-98cc-1091af2c9943", "ParentID": "241e88d1-18fb-4b17-aa71-c681372da196", "AncestorID": "b4dd1e1b-3302-42b4-a2b9-85468760ce5d", "Rank": 1, "Color": "sample string 1", "HoursActual": 1.0, "HoursProjected": 1.0, "TrackingLabel": "sample string 6", "NearHighlightOverride": 1, "Name": "sample string 7", "Description": "sample string 8", "StatusID": 1, "PhaseID": 1, "AncestorName": "sample string 9", "RankOrder": "sample string 10", "DisplayRank": "sample string 11", "Level": 1, "SumHoursActual": 1.0, "SumHoursProjected": 1.0, "Status": "sample string 12", "Phase": "sample string 13", "Deleted": true, "DeletedByRef": true, "Created": "sample string 14", "CreatedBy": "d7d02722-24b3-4bef-82fe-2cc91c339793", "Updated": "2025-09-11T02:54:43.770407+00:00", "UpdatedBy": "d732753c-5771-4ca1-861a-1d8798e48879", "TeamMembers": "sample string 15", "LastComment": "sample string 16", "LastCommentDate": "2025-09-11T02:54:43.770407+00:00", "LastCommentByID": "1c88acc3-e1fb-4869-a6ba-154d3cdad0d9", "LastCommentBy": "sample string 17", "EndDateChanges": 1, "IncludeSurveys": true, "AncestorType": 1, "Draft": true, "LinkedToID": "1ee91fa8-a9ad-4546-a31a-2dd0e5a9cabd", "TeamMemberList": [ { "TaskID": "46a77c25-e36c-4097-9268-c551687efbff", "IndividualID": "71df5fed-ec60-452a-be36-19fc7e37b627", "RoleID": "7922ea47-63ee-407d-8cba-d89a30eeddaa", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "2e00962f-72e9-4588-b983-045d73faa782", "RoleName": "sample string 1", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "IndividualFullName": "sample string 2", "Created": "2025-09-11T02:54:43.770407+00:00", "CreatedBy": "b0d2b29e-5de0-456c-9a4f-1eaff91f8751", "SiteID": "4053521d-99b5-407f-a362-9714b6ec4498", "Updated": "2025-09-11T02:54:43.770407+00:00", "UpdatedBy": "11948350-bf16-4f19-baf0-3cb8e4afc937", "IndividualFullOrderedName": "sample string 3", "RoleDescription": "sample string 4", "TeamSurvey": true }, { "TaskID": "46a77c25-e36c-4097-9268-c551687efbff", "IndividualID": "71df5fed-ec60-452a-be36-19fc7e37b627", "RoleID": "7922ea47-63ee-407d-8cba-d89a30eeddaa", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "2e00962f-72e9-4588-b983-045d73faa782", "RoleName": "sample string 1", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "IndividualFullName": "sample string 2", "Created": "2025-09-11T02:54:43.770407+00:00", "CreatedBy": "b0d2b29e-5de0-456c-9a4f-1eaff91f8751", "SiteID": "4053521d-99b5-407f-a362-9714b6ec4498", "Updated": "2025-09-11T02:54:43.770407+00:00", "UpdatedBy": "11948350-bf16-4f19-baf0-3cb8e4afc937", "IndividualFullOrderedName": "sample string 3", "RoleDescription": "sample string 4", "TeamSurvey": true } ], "StatusName": "sample string 18", "StatusRank": 1, "PhaseName": "sample string 19", "PhaseRank": 1, "ColorName": "sample string 20", "ColorRank": 1, "LinkedAncestorID": "1898f38f-4d14-40a5-8ff5-7953ff66e6f9", "LinkedToName": "sample string 21", "LinkedToRowType": 1, "LinkedAncestorName": "sample string 22", "RowType": 1, "RankPath": "QEA=", "OnTime": true, "CanRead": true, "CanUpdate": true, "CanDelete": true, "CanDelegate": true, "NearHighlight": 1 }