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": [
"80a56519-4c15-493d-8ac0-d7334ede45fc",
"2c2a5ec8-2452-4c16-9380-65c6f2f82293"
],
"StartRange": "2025-11-17T12:06:05Z",
"EndRange": "2025-11-17T12:06:05Z",
"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": "e46095f0-8597-4634-b8ff-653b10d2442c",
"SeriesId": "6bf10cba-528b-46b4-8355-a6aa2db48b7b",
"AccessorID": "1c2f8a15-e333-4e9d-ad66-04ae9bf07e92",
"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": "6f223b3d-4743-4080-bb77-d7a3e29ed00d",
"ScheduledByID": "f9e4340a-504e-4a93-8e46-8b2ac73de88b",
"DeletedDates": [
"2025-11-17T12:06:05Z",
"2025-11-17T12:06:05Z"
],
"ClearedDates": [
"2025-11-17T12:06:05Z",
"2025-11-17T12:06:05Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-17T12:06:05Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-17T12:06:05Z",
"CreateDate": "2025-11-17T12:06:05Z",
"OccurTime": "2025-11-17T12:06:05Z",
"OccurEndTime": "2025-11-17T12:06:05Z",
"StartTime": "2025-11-17T12:06:05Z",
"EndTime": "2025-11-17T12:06:05Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa30ed1b-1a9b-49b6-a15c-b8e57e31beb4",
"c3dd30b7-0b1c-403a-8086-f00bd3fd0c8c"
],
"Companies": [
"4e6512fd-351c-4bfb-824a-fd56aacd93c4",
"f72b97d3-f233-4ef8-89b2-da0f476b87a3"
],
"Groups": [
"b7052c97-0130-481b-967f-3650b02f0bd3",
"b7e66bd4-84ee-4eba-b5f9-59cf540ead29"
],
"Opportunities": [
"7c741983-55f2-4aea-a35b-1aac7904e70a",
"c3d29813-1a9e-47c7-8c58-19d379911049"
]
}
},
{
"Id": "e46095f0-8597-4634-b8ff-653b10d2442c",
"SeriesId": "6bf10cba-528b-46b4-8355-a6aa2db48b7b",
"AccessorID": "1c2f8a15-e333-4e9d-ad66-04ae9bf07e92",
"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": "6f223b3d-4743-4080-bb77-d7a3e29ed00d",
"ScheduledByID": "f9e4340a-504e-4a93-8e46-8b2ac73de88b",
"DeletedDates": [
"2025-11-17T12:06:05Z",
"2025-11-17T12:06:05Z"
],
"ClearedDates": [
"2025-11-17T12:06:05Z",
"2025-11-17T12:06:05Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-17T12:06:05Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-17T12:06:05Z",
"CreateDate": "2025-11-17T12:06:05Z",
"OccurTime": "2025-11-17T12:06:05Z",
"OccurEndTime": "2025-11-17T12:06:05Z",
"StartTime": "2025-11-17T12:06:05Z",
"EndTime": "2025-11-17T12:06:05Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa30ed1b-1a9b-49b6-a15c-b8e57e31beb4",
"c3dd30b7-0b1c-403a-8086-f00bd3fd0c8c"
],
"Companies": [
"4e6512fd-351c-4bfb-824a-fd56aacd93c4",
"f72b97d3-f233-4ef8-89b2-da0f476b87a3"
],
"Groups": [
"b7052c97-0130-481b-967f-3650b02f0bd3",
"b7e66bd4-84ee-4eba-b5f9-59cf540ead29"
],
"Opportunities": [
"7c741983-55f2-4aea-a35b-1aac7904e70a",
"c3d29813-1a9e-47c7-8c58-19d379911049"
]
}
}
]