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": [
"c8b9d1bd-0439-421e-9748-1f051bdfff15",
"32b2614a-c73b-4aa8-a854-13573aa2fabc"
],
"StartRange": "2026-05-04T02:59:32Z",
"EndRange": "2026-05-04T02:59:32Z",
"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": "40e8e5d0-3f40-4db1-a7ae-a5a071f401df",
"SeriesId": "bbb00fb2-c348-4c56-9ccc-ea10a30e1e2c",
"AccessorID": "dc9a7b2d-d04b-40e7-9b2f-79b981a7b54b",
"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": "45e46942-469f-4ee8-a614-dd070d6bb3fd",
"ScheduledByID": "f88ddcdc-c566-4a20-9925-78f86e3fe9a0",
"DeletedDates": [
"2026-05-04T02:59:32Z",
"2026-05-04T02:59:32Z"
],
"ClearedDates": [
"2026-05-04T02:59:32Z",
"2026-05-04T02:59:32Z"
],
"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-04T02:59:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T02:59:32Z",
"CreateDate": "2026-05-04T02:59:32Z",
"OccurTime": "2026-05-04T02:59:32Z",
"OccurEndTime": "2026-05-04T02:59:32Z",
"StartTime": "2026-05-04T02:59:32Z",
"EndTime": "2026-05-04T02:59:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4e3865dd-d6d5-48a3-b78a-938117ef1b2d",
"7e337dc0-d708-4877-b190-600dc23c6bf4"
],
"Companies": [
"c5deaeba-e768-4b7c-8f3b-fda9a59d38f5",
"522ac485-6395-4441-b4f8-8120d7a41cde"
],
"Groups": [
"ba3c0a9d-a0b1-46ea-95b6-f60a25375b65",
"2962a8d4-1195-4a65-aedb-6fb30e0db492"
],
"Opportunities": [
"33bd2b31-9797-485a-899a-a9ca042b74bd",
"6e36f11c-21e3-4738-9f36-b3e99b306223"
]
}
},
{
"Id": "40e8e5d0-3f40-4db1-a7ae-a5a071f401df",
"SeriesId": "bbb00fb2-c348-4c56-9ccc-ea10a30e1e2c",
"AccessorID": "dc9a7b2d-d04b-40e7-9b2f-79b981a7b54b",
"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": "45e46942-469f-4ee8-a614-dd070d6bb3fd",
"ScheduledByID": "f88ddcdc-c566-4a20-9925-78f86e3fe9a0",
"DeletedDates": [
"2026-05-04T02:59:32Z",
"2026-05-04T02:59:32Z"
],
"ClearedDates": [
"2026-05-04T02:59:32Z",
"2026-05-04T02:59:32Z"
],
"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-04T02:59:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T02:59:32Z",
"CreateDate": "2026-05-04T02:59:32Z",
"OccurTime": "2026-05-04T02:59:32Z",
"OccurEndTime": "2026-05-04T02:59:32Z",
"StartTime": "2026-05-04T02:59:32Z",
"EndTime": "2026-05-04T02:59:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4e3865dd-d6d5-48a3-b78a-938117ef1b2d",
"7e337dc0-d708-4877-b190-600dc23c6bf4"
],
"Companies": [
"c5deaeba-e768-4b7c-8f3b-fda9a59d38f5",
"522ac485-6395-4441-b4f8-8120d7a41cde"
],
"Groups": [
"ba3c0a9d-a0b1-46ea-95b6-f60a25375b65",
"2962a8d4-1195-4a65-aedb-6fb30e0db492"
],
"Opportunities": [
"33bd2b31-9797-485a-899a-a9ca042b74bd",
"6e36f11c-21e3-4738-9f36-b3e99b306223"
]
}
}
]