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": [
"0a9faca6-bb35-4cc1-8ef7-fcf72f3eb410",
"e4b6a03f-199c-45af-b3a7-6b605c6c4cbb"
],
"StartRange": "2026-04-03T06:29:00Z",
"EndRange": "2026-04-03T06:29:00Z",
"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": "12d4645e-f802-4846-879f-b2910cdcdb09",
"SeriesId": "997546c7-4705-458b-9dfd-4278950b9c87",
"AccessorID": "d3b85c5b-be7f-4874-8a31-2ddc145c6b0e",
"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": "12c6bda4-f431-4282-b80c-a9e790135345",
"ScheduledByID": "5688225b-b742-44d7-bb19-83b88a34e12e",
"DeletedDates": [
"2026-04-03T06:29:00Z",
"2026-04-03T06:29:00Z"
],
"ClearedDates": [
"2026-04-03T06:29:00Z",
"2026-04-03T06:29:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-03T06:29:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-03T06:29:00Z",
"CreateDate": "2026-04-03T06:29:00Z",
"OccurTime": "2026-04-03T06:29:00Z",
"OccurEndTime": "2026-04-03T06:29:00Z",
"StartTime": "2026-04-03T06:29:00Z",
"EndTime": "2026-04-03T06:29:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f8dc2b65-259c-4b8c-ace3-bb7841fb6f6b",
"d4a10458-c9ce-43e8-a15a-0ac481568946"
],
"Companies": [
"4d9bafe5-50e2-49ad-89b8-cc212772ffdd",
"fa2140d4-e0cc-4437-a56a-de3089809a6a"
],
"Groups": [
"a54ac5a3-2749-46fd-9b5d-b099d66a2609",
"8c3ce129-5f93-46a9-9794-ec0bf145cafe"
],
"Opportunities": [
"58f706cb-39e6-4f42-8230-5b487d645748",
"164e8285-affd-40b5-88ad-e5fed7554390"
]
}
},
{
"Id": "12d4645e-f802-4846-879f-b2910cdcdb09",
"SeriesId": "997546c7-4705-458b-9dfd-4278950b9c87",
"AccessorID": "d3b85c5b-be7f-4874-8a31-2ddc145c6b0e",
"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": "12c6bda4-f431-4282-b80c-a9e790135345",
"ScheduledByID": "5688225b-b742-44d7-bb19-83b88a34e12e",
"DeletedDates": [
"2026-04-03T06:29:00Z",
"2026-04-03T06:29:00Z"
],
"ClearedDates": [
"2026-04-03T06:29:00Z",
"2026-04-03T06:29:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-03T06:29:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-03T06:29:00Z",
"CreateDate": "2026-04-03T06:29:00Z",
"OccurTime": "2026-04-03T06:29:00Z",
"OccurEndTime": "2026-04-03T06:29:00Z",
"StartTime": "2026-04-03T06:29:00Z",
"EndTime": "2026-04-03T06:29:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f8dc2b65-259c-4b8c-ace3-bb7841fb6f6b",
"d4a10458-c9ce-43e8-a15a-0ac481568946"
],
"Companies": [
"4d9bafe5-50e2-49ad-89b8-cc212772ffdd",
"fa2140d4-e0cc-4437-a56a-de3089809a6a"
],
"Groups": [
"a54ac5a3-2749-46fd-9b5d-b099d66a2609",
"8c3ce129-5f93-46a9-9794-ec0bf145cafe"
],
"Opportunities": [
"58f706cb-39e6-4f42-8230-5b487d645748",
"164e8285-affd-40b5-88ad-e5fed7554390"
]
}
}
]