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": [
"6c5f1b05-ead1-4777-84b4-f19255d077f1",
"1023dbd2-69d5-4cec-9551-20b65dbe8bcd"
],
"StartRange": "2025-12-27T20:27:38Z",
"EndRange": "2025-12-27T20:27:38Z",
"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": "e94f1612-219f-45dd-bf58-a5f5fc31e47b",
"SeriesId": "82fef5dc-0b82-4d9d-b2fe-dfe30dcf0f96",
"AccessorID": "01aabc0c-df9f-4a66-9f6f-9d5b1575ed29",
"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": "ee3f384a-bf97-4ec0-80f0-94a7c00d9144",
"ScheduledByID": "fd7547cf-2a5c-40d4-bb4c-89a7512dbbdf",
"DeletedDates": [
"2025-12-27T20:27:38Z",
"2025-12-27T20:27:38Z"
],
"ClearedDates": [
"2025-12-27T20:27:38Z",
"2025-12-27T20:27:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-27T20:27:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-27T20:27:38Z",
"CreateDate": "2025-12-27T20:27:38Z",
"OccurTime": "2025-12-27T20:27:38Z",
"OccurEndTime": "2025-12-27T20:27:38Z",
"StartTime": "2025-12-27T20:27:38Z",
"EndTime": "2025-12-27T20:27:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5ebfe59-c26c-4e74-b40b-1feb07bcf7a6",
"be69dc60-2d6d-4fa4-9cb4-daa033613dba"
],
"Companies": [
"60a34cf2-22c6-412b-80f5-4c698f9f7a55",
"b8dfc4a9-a0be-4df5-b113-9aef580364c7"
],
"Groups": [
"2565195b-ffbd-49c0-b8e3-2a4170b7df7a",
"3452a127-4004-4042-82c9-148061460c39"
],
"Opportunities": [
"132e3fa9-3763-4805-af54-97d044e189de",
"9fd89ae6-784e-4115-b325-9b67deb5a901"
]
}
},
{
"Id": "e94f1612-219f-45dd-bf58-a5f5fc31e47b",
"SeriesId": "82fef5dc-0b82-4d9d-b2fe-dfe30dcf0f96",
"AccessorID": "01aabc0c-df9f-4a66-9f6f-9d5b1575ed29",
"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": "ee3f384a-bf97-4ec0-80f0-94a7c00d9144",
"ScheduledByID": "fd7547cf-2a5c-40d4-bb4c-89a7512dbbdf",
"DeletedDates": [
"2025-12-27T20:27:38Z",
"2025-12-27T20:27:38Z"
],
"ClearedDates": [
"2025-12-27T20:27:38Z",
"2025-12-27T20:27:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-27T20:27:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-27T20:27:38Z",
"CreateDate": "2025-12-27T20:27:38Z",
"OccurTime": "2025-12-27T20:27:38Z",
"OccurEndTime": "2025-12-27T20:27:38Z",
"StartTime": "2025-12-27T20:27:38Z",
"EndTime": "2025-12-27T20:27:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5ebfe59-c26c-4e74-b40b-1feb07bcf7a6",
"be69dc60-2d6d-4fa4-9cb4-daa033613dba"
],
"Companies": [
"60a34cf2-22c6-412b-80f5-4c698f9f7a55",
"b8dfc4a9-a0be-4df5-b113-9aef580364c7"
],
"Groups": [
"2565195b-ffbd-49c0-b8e3-2a4170b7df7a",
"3452a127-4004-4042-82c9-148061460c39"
],
"Opportunities": [
"132e3fa9-3763-4805-af54-97d044e189de",
"9fd89ae6-784e-4115-b325-9b67deb5a901"
]
}
}
]