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": [
"10e769d6-ed6b-4959-98c0-a7fd42365d39",
"29ccff40-e567-4c5e-a535-53de3051ed6d"
],
"StartRange": "2025-11-24T09:26:25Z",
"EndRange": "2025-11-24T09:26:25Z",
"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": "c4b56f20-2401-4717-bb16-68e2b7bec0cc",
"SeriesId": "9e235b4c-89a8-436f-b37b-d96692123076",
"AccessorID": "0a170817-32b4-452e-8647-77e2999b74bb",
"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": "15a6013b-c591-4043-b016-991d2b31eaee",
"ScheduledByID": "d3e1f5a2-3ec2-4bc9-bf62-65c03bd63bbc",
"DeletedDates": [
"2025-11-24T09:26:25Z",
"2025-11-24T09:26:25Z"
],
"ClearedDates": [
"2025-11-24T09:26:25Z",
"2025-11-24T09:26:25Z"
],
"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-24T09:26:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-24T09:26:25Z",
"CreateDate": "2025-11-24T09:26:25Z",
"OccurTime": "2025-11-24T09:26:25Z",
"OccurEndTime": "2025-11-24T09:26:25Z",
"StartTime": "2025-11-24T09:26:25Z",
"EndTime": "2025-11-24T09:26:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f34939f2-e0e4-41ca-a6cf-2fae54521ccf",
"38a1128d-2bdc-4ca5-a44b-f6ba9760a260"
],
"Companies": [
"46b0e30d-0f71-4028-b366-58cdfdd58c6f",
"7fe58821-3b8e-4c78-8bea-d228cbcc318e"
],
"Groups": [
"e6ac9e54-b7fa-4cbe-ab1e-340ece15db01",
"b0aa7caf-0477-48b8-b34f-069ee621b52a"
],
"Opportunities": [
"18328690-bc41-4197-aca9-354d32781162",
"f7012dec-e969-45be-baea-cd79658fd577"
]
}
},
{
"Id": "c4b56f20-2401-4717-bb16-68e2b7bec0cc",
"SeriesId": "9e235b4c-89a8-436f-b37b-d96692123076",
"AccessorID": "0a170817-32b4-452e-8647-77e2999b74bb",
"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": "15a6013b-c591-4043-b016-991d2b31eaee",
"ScheduledByID": "d3e1f5a2-3ec2-4bc9-bf62-65c03bd63bbc",
"DeletedDates": [
"2025-11-24T09:26:25Z",
"2025-11-24T09:26:25Z"
],
"ClearedDates": [
"2025-11-24T09:26:25Z",
"2025-11-24T09:26:25Z"
],
"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-24T09:26:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-24T09:26:25Z",
"CreateDate": "2025-11-24T09:26:25Z",
"OccurTime": "2025-11-24T09:26:25Z",
"OccurEndTime": "2025-11-24T09:26:25Z",
"StartTime": "2025-11-24T09:26:25Z",
"EndTime": "2025-11-24T09:26:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f34939f2-e0e4-41ca-a6cf-2fae54521ccf",
"38a1128d-2bdc-4ca5-a44b-f6ba9760a260"
],
"Companies": [
"46b0e30d-0f71-4028-b366-58cdfdd58c6f",
"7fe58821-3b8e-4c78-8bea-d228cbcc318e"
],
"Groups": [
"e6ac9e54-b7fa-4cbe-ab1e-340ece15db01",
"b0aa7caf-0477-48b8-b34f-069ee621b52a"
],
"Opportunities": [
"18328690-bc41-4197-aca9-354d32781162",
"f7012dec-e969-45be-baea-cd79658fd577"
]
}
}
]