POST api/TaskList
Retrieve tasklists for one or more users in the database
Request Information
URI Parameters
None.
Body Parameters
TaskListParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| UserIds | Collection of globally unique identifier |
None. |
|
| StartRange | date |
None. |
|
| EndRange | date |
None. |
|
| IncludeCleared | boolean |
None. |
|
| FirstOccurrenceOnly | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserIds": [
"f2ccb60a-67cc-4486-9f88-312599fc9979",
"b1e2f0e7-793d-4b9b-b768-f2acc838211b"
],
"StartRange": "2026-02-28T21:46:41Z",
"EndRange": "2026-02-28T21:46:41Z",
"IncludeCleared": true,
"FirstOccurrenceOnly": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of Activity| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| SeriesId | globally unique identifier |
None. |
|
| AccessorID | globally unique identifier |
None. |
|
| IsCleared | boolean |
None. |
|
| IsAlarmCreated | boolean |
None. |
|
| IsAlarmed | boolean |
None. |
|
| LeadMinutes | integer |
None. |
|
| AlarmDue | string |
None. |
|
| ExternalID | string |
None. |
|
| Location | string |
None. |
|
| IsTimeless | boolean |
None. |
|
| IsPrivate | boolean |
None. |
|
| PriorityId | integer |
None. |
|
| ActivityPriorityName | string |
None. |
|
| ActivityTypeId | integer |
None. |
|
| ActivityTypeName | string |
None. |
|
| Subject | string |
None. |
|
| ScheduledBy | string |
None. |
|
| ScheduledFor | string |
None. |
|
| ScheduledForID | globally unique identifier |
None. |
|
| ScheduledByID | globally unique identifier |
None. |
|
| DeletedDates | Collection of date |
None. |
|
| ClearedDates | Collection of date |
None. |
|
| RecurSpec | ActivityRecurSpec |
None. |
|
| EditDate | date |
None. |
|
| CreateDate | date |
None. |
|
| OccurTime | date |
None. |
|
| OccurEndTime | date |
None. |
|
| StartTime |
SQL Column Name: [START_DATE_TIME] |
date |
None. |
| EndTime |
SQL Column Name: [END_DATE_TIME] |
date |
None. |
| Details |
SQL Column Name: [DETAILS] |
string |
None. |
| LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "e7694cea-aad5-49ab-9748-a3a244f70b59",
"SeriesId": "6e3c9b25-9174-4d97-97b8-9a353469b5c5",
"AccessorID": "80370ffc-7000-4922-aeab-448088287c97",
"IsCleared": true,
"IsAlarmCreated": true,
"IsAlarmed": true,
"LeadMinutes": 7,
"AlarmDue": "sample string 8",
"ExternalID": "sample string 9",
"Location": "sample string 10",
"IsTimeless": true,
"IsPrivate": true,
"PriorityId": 13,
"ActivityPriorityName": "sample string 14",
"ActivityTypeId": 15,
"ActivityTypeName": "sample string 16",
"Subject": "sample string 17",
"ScheduledBy": "sample string 18",
"ScheduledFor": "sample string 19",
"ScheduledForID": "aa822b7c-92ae-44e3-a64a-2a813732d4b2",
"ScheduledByID": "870135aa-165a-4a65-b215-a38dcee1d7cf",
"DeletedDates": [
"2026-02-28T21:46:41Z",
"2026-02-28T21:46:41Z"
],
"ClearedDates": [
"2026-02-28T21:46:41Z",
"2026-02-28T21:46:41Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T21:46:41Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T21:46:41Z",
"CreateDate": "2026-02-28T21:46:41Z",
"OccurTime": "2026-02-28T21:46:41Z",
"OccurEndTime": "2026-02-28T21:46:41Z",
"StartTime": "2026-02-28T21:46:41Z",
"EndTime": "2026-02-28T21:46:41Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"00b976ef-cc26-4186-b87b-1e2a74ef23fd",
"d9883d55-ffcb-4a5e-869b-9cc7e1d16a21"
],
"Companies": [
"2ac88abf-5c83-4cd2-b61e-2272b520ea2d",
"e0f64c7f-3d8d-426c-8968-8de6c458ebc9"
],
"Groups": [
"161634c4-bf0e-424e-b71d-632a61bc66f6",
"7b25250c-0da2-412c-8cf7-c88bca0834fe"
],
"Opportunities": [
"5ea6ab29-aa64-4c35-9f08-13a500b945b1",
"ecf62ac7-4c8b-4924-be65-0c72531968ee"
]
}
},
{
"Id": "e7694cea-aad5-49ab-9748-a3a244f70b59",
"SeriesId": "6e3c9b25-9174-4d97-97b8-9a353469b5c5",
"AccessorID": "80370ffc-7000-4922-aeab-448088287c97",
"IsCleared": true,
"IsAlarmCreated": true,
"IsAlarmed": true,
"LeadMinutes": 7,
"AlarmDue": "sample string 8",
"ExternalID": "sample string 9",
"Location": "sample string 10",
"IsTimeless": true,
"IsPrivate": true,
"PriorityId": 13,
"ActivityPriorityName": "sample string 14",
"ActivityTypeId": 15,
"ActivityTypeName": "sample string 16",
"Subject": "sample string 17",
"ScheduledBy": "sample string 18",
"ScheduledFor": "sample string 19",
"ScheduledForID": "aa822b7c-92ae-44e3-a64a-2a813732d4b2",
"ScheduledByID": "870135aa-165a-4a65-b215-a38dcee1d7cf",
"DeletedDates": [
"2026-02-28T21:46:41Z",
"2026-02-28T21:46:41Z"
],
"ClearedDates": [
"2026-02-28T21:46:41Z",
"2026-02-28T21:46:41Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T21:46:41Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T21:46:41Z",
"CreateDate": "2026-02-28T21:46:41Z",
"OccurTime": "2026-02-28T21:46:41Z",
"OccurEndTime": "2026-02-28T21:46:41Z",
"StartTime": "2026-02-28T21:46:41Z",
"EndTime": "2026-02-28T21:46:41Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"00b976ef-cc26-4186-b87b-1e2a74ef23fd",
"d9883d55-ffcb-4a5e-869b-9cc7e1d16a21"
],
"Companies": [
"2ac88abf-5c83-4cd2-b61e-2272b520ea2d",
"e0f64c7f-3d8d-426c-8968-8de6c458ebc9"
],
"Groups": [
"161634c4-bf0e-424e-b71d-632a61bc66f6",
"7b25250c-0da2-412c-8cf7-c88bca0834fe"
],
"Opportunities": [
"5ea6ab29-aa64-4c35-9f08-13a500b945b1",
"ecf62ac7-4c8b-4924-be65-0c72531968ee"
]
}
}
]