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": [
"402cfd11-8cd3-42ce-b767-8b79ba0d9a6d",
"8a92cc0a-dbb6-4ded-af17-01ffb10e8b73"
],
"StartRange": "2026-05-05T04:12:14Z",
"EndRange": "2026-05-05T04:12:14Z",
"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": "2cec1bfb-5413-4270-8dbc-c181543a2507",
"SeriesId": "6e39eb7a-a403-4171-96a1-162b3791f2b8",
"AccessorID": "ce0ed2bf-43a7-42ca-b2a5-38a9668d3423",
"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": "61ef9045-b2a1-4f37-bd69-e99c83864988",
"ScheduledByID": "214f0722-3825-4a64-b7a7-8b3a2ded304b",
"DeletedDates": [
"2026-05-05T04:12:14Z",
"2026-05-05T04:12:14Z"
],
"ClearedDates": [
"2026-05-05T04:12:14Z",
"2026-05-05T04:12:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-05T04:12:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-05T04:12:14Z",
"CreateDate": "2026-05-05T04:12:14Z",
"OccurTime": "2026-05-05T04:12:14Z",
"OccurEndTime": "2026-05-05T04:12:14Z",
"StartTime": "2026-05-05T04:12:14Z",
"EndTime": "2026-05-05T04:12:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3eac290a-c2a8-4cac-b108-20c6e99625d6",
"f3c5c500-2e60-4437-9471-47c31826ddb9"
],
"Companies": [
"31059eb6-5a5c-43dc-8182-ed424335cd51",
"cd388a6a-eb67-4093-8e04-ca8cf8a922d9"
],
"Groups": [
"2474c6a5-4015-4e5a-869b-b60db96e7c6c",
"64913166-7231-4365-beea-986aaa0ed853"
],
"Opportunities": [
"48433706-05db-4f71-9b26-7c121db371db",
"b30f6493-ab47-40b9-9a27-95c09c33f76a"
]
}
},
{
"Id": "2cec1bfb-5413-4270-8dbc-c181543a2507",
"SeriesId": "6e39eb7a-a403-4171-96a1-162b3791f2b8",
"AccessorID": "ce0ed2bf-43a7-42ca-b2a5-38a9668d3423",
"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": "61ef9045-b2a1-4f37-bd69-e99c83864988",
"ScheduledByID": "214f0722-3825-4a64-b7a7-8b3a2ded304b",
"DeletedDates": [
"2026-05-05T04:12:14Z",
"2026-05-05T04:12:14Z"
],
"ClearedDates": [
"2026-05-05T04:12:14Z",
"2026-05-05T04:12:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-05T04:12:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-05T04:12:14Z",
"CreateDate": "2026-05-05T04:12:14Z",
"OccurTime": "2026-05-05T04:12:14Z",
"OccurEndTime": "2026-05-05T04:12:14Z",
"StartTime": "2026-05-05T04:12:14Z",
"EndTime": "2026-05-05T04:12:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3eac290a-c2a8-4cac-b108-20c6e99625d6",
"f3c5c500-2e60-4437-9471-47c31826ddb9"
],
"Companies": [
"31059eb6-5a5c-43dc-8182-ed424335cd51",
"cd388a6a-eb67-4093-8e04-ca8cf8a922d9"
],
"Groups": [
"2474c6a5-4015-4e5a-869b-b60db96e7c6c",
"64913166-7231-4365-beea-986aaa0ed853"
],
"Opportunities": [
"48433706-05db-4f71-9b26-7c121db371db",
"b30f6493-ab47-40b9-9a27-95c09c33f76a"
]
}
}
]