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": [
"f2e44f36-2e1e-4ceb-bce1-2d47430bbc6a",
"9d328e78-28b4-4282-b4e1-5e3b3f87d30a"
],
"StartRange": "2026-04-07T23:29:09Z",
"EndRange": "2026-04-07T23:29:09Z",
"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": "b240bda1-6b85-4a0f-b1dd-9dce2b741d70",
"SeriesId": "2f1dfade-1b9d-4afe-ae80-ac63bbdb7f8b",
"AccessorID": "9851f956-7077-4ad7-b6f7-830118880555",
"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": "1526e14b-a711-4dfa-9d15-20429f86df87",
"ScheduledByID": "d94bf69d-e90e-484a-8bf9-f3089c33ee37",
"DeletedDates": [
"2026-04-07T23:29:09Z",
"2026-04-07T23:29:09Z"
],
"ClearedDates": [
"2026-04-07T23:29:09Z",
"2026-04-07T23:29:09Z"
],
"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-07T23:29:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-07T23:29:09Z",
"CreateDate": "2026-04-07T23:29:09Z",
"OccurTime": "2026-04-07T23:29:09Z",
"OccurEndTime": "2026-04-07T23:29:09Z",
"StartTime": "2026-04-07T23:29:09Z",
"EndTime": "2026-04-07T23:29:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1b4daa1f-2169-450d-9f06-5b380b1edbd8",
"c5d03fc6-893f-4036-a0be-f93d3f530ca9"
],
"Companies": [
"ae1eeb3a-c519-4e32-97c2-2013cc18d112",
"3c702a6b-4eb5-4768-97bf-12692970094a"
],
"Groups": [
"2871f63a-0177-42b2-8eaf-1c6b7b6abc35",
"da702126-32a4-4a9b-93e3-61d919ed010d"
],
"Opportunities": [
"3428ecbd-cf72-46d9-8838-a937bdd49343",
"d556e396-b1a1-4133-9aaa-37152354ee9f"
]
}
},
{
"Id": "b240bda1-6b85-4a0f-b1dd-9dce2b741d70",
"SeriesId": "2f1dfade-1b9d-4afe-ae80-ac63bbdb7f8b",
"AccessorID": "9851f956-7077-4ad7-b6f7-830118880555",
"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": "1526e14b-a711-4dfa-9d15-20429f86df87",
"ScheduledByID": "d94bf69d-e90e-484a-8bf9-f3089c33ee37",
"DeletedDates": [
"2026-04-07T23:29:09Z",
"2026-04-07T23:29:09Z"
],
"ClearedDates": [
"2026-04-07T23:29:09Z",
"2026-04-07T23:29:09Z"
],
"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-07T23:29:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-07T23:29:09Z",
"CreateDate": "2026-04-07T23:29:09Z",
"OccurTime": "2026-04-07T23:29:09Z",
"OccurEndTime": "2026-04-07T23:29:09Z",
"StartTime": "2026-04-07T23:29:09Z",
"EndTime": "2026-04-07T23:29:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1b4daa1f-2169-450d-9f06-5b380b1edbd8",
"c5d03fc6-893f-4036-a0be-f93d3f530ca9"
],
"Companies": [
"ae1eeb3a-c519-4e32-97c2-2013cc18d112",
"3c702a6b-4eb5-4768-97bf-12692970094a"
],
"Groups": [
"2871f63a-0177-42b2-8eaf-1c6b7b6abc35",
"da702126-32a4-4a9b-93e3-61d919ed010d"
],
"Opportunities": [
"3428ecbd-cf72-46d9-8838-a937bdd49343",
"d556e396-b1a1-4133-9aaa-37152354ee9f"
]
}
}
]