GET v1/Tasks/{TaskId}/TaskNotes?TaskNoteId={TaskNoteId}&Comment={Comment}&CreationDate={CreationDate}&CreationUserId={CreationUserId}&CorrectedTaskNoteId={CorrectedTaskNoteId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}
Retrieve Task's Notes
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| TaskNoteId | string |
None. |
|
| TaskId | string |
None. |
|
| Comment | string |
None. |
|
| CreationDate | string |
None. |
|
| CreationUserId | string |
None. |
|
| CorrectedTaskNoteId | string |
None. |
|
| Limit |
Maximum number of records to return |
integer |
Range: inclusive between 1 and 2147483647 |
| Offset |
Number of records to skip during search, useful for pagination |
integer |
Range: inclusive between 0 and 2147483647 |
| Total |
Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. |
boolean |
None. |
| SortDirection |
Direction of sort: Ascending or Descending |
SortDirection |
None. |
| Sort |
Comma separated list of field names to sort by |
string |
None. |
| Expand |
Comma separated list of expansions to include in results |
string |
None. |
| TaskId | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Retrieve Task's Notes
TaskNoteListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Limit |
Echoed limit of request |
integer |
None. |
| Offset |
Echoed offset of request |
integer |
None. |
| Total |
Total records matching search, if requested |
integer |
None. |
| Data |
List of records matching the search |
Collection of TaskNoteOutboundDTO |
None. |
Response Formats
application/json, text/json
{
"Limit": 1,
"Offset": 1,
"Total": 1,
"Data": [
{
"Id": 1,
"TaskId": 1,
"Comment": "sample string 2",
"CreationDate": "2026-04-14T23:04:39.6902991-10:00",
"CreationUserId": 1,
"CorrectedTaskNoteId": 1
},
{
"Id": 1,
"TaskId": 1,
"Comment": "sample string 2",
"CreationDate": "2026-04-14T23:04:39.6902991-10:00",
"CreationUserId": 1,
"CorrectedTaskNoteId": 1
}
]
}
application/xml, text/xml
<TaskNoteListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
<Data>
<TaskNoteOutboundDTO>
<Id>1</Id>
<Comment>sample string 2</Comment>
<CorrectedTaskNoteId>1</CorrectedTaskNoteId>
<CreationDate>2026-04-14T23:04:39.6902991-10:00</CreationDate>
<CreationUserId>1</CreationUserId>
<TaskId>1</TaskId>
</TaskNoteOutboundDTO>
<TaskNoteOutboundDTO>
<Id>1</Id>
<Comment>sample string 2</Comment>
<CorrectedTaskNoteId>1</CorrectedTaskNoteId>
<CreationDate>2026-04-14T23:04:39.6902991-10:00</CreationDate>
<CreationUserId>1</CreationUserId>
<TaskId>1</TaskId>
</TaskNoteOutboundDTO>
</Data>
<Limit>1</Limit>
<Offset>1</Offset>
<Total>1</Total>
</TaskNoteListResponse>