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": [
"334c0c34-de6b-4d85-856a-f6851a38f3f0",
"f7edb0da-4e12-4baf-94e1-65164d155e2a"
],
"StartRange": "2025-07-05T16:14:25Z",
"EndRange": "2025-07-05T16:14: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": "b8316a85-6144-45ab-91c0-926cf8ead028",
"SeriesId": "c7882573-116d-4889-8d37-a38d39913d84",
"AccessorID": "4591528e-b59a-4a61-983a-e1e1db06c097",
"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": "1d84168b-5ba0-4312-ac0e-14f8911d537a",
"ScheduledByID": "107723d7-4ed0-4c67-9d18-e3803a389553",
"DeletedDates": [
"2025-07-05T16:14:25Z",
"2025-07-05T16:14:25Z"
],
"ClearedDates": [
"2025-07-05T16:14:25Z",
"2025-07-05T16:14: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-07-05T16:14:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-07-05T16:14:25Z",
"CreateDate": "2025-07-05T16:14:25Z",
"OccurTime": "2025-07-05T16:14:25Z",
"OccurEndTime": "2025-07-05T16:14:25Z",
"StartTime": "2025-07-05T16:14:25Z",
"EndTime": "2025-07-05T16:14:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"48ed11fa-4be0-48dd-a621-954c09a62477",
"5be0ec4f-1224-450a-9d2b-8473f59696e5"
],
"Companies": [
"39542d3a-d069-4871-b0e1-ebacb9e2b613",
"59f3d8bd-680e-4db4-a471-90467d3ac7ac"
],
"Groups": [
"a1ff0f61-230f-436e-87c8-0694dcf88bbc",
"074957b8-cb52-48bd-b107-78bf8e7d34a8"
],
"Opportunities": [
"f19752a6-1a68-4eb5-9f62-81103d506e55",
"60e91a1c-a548-4f32-abd4-002a84aa7ff4"
]
}
},
{
"Id": "b8316a85-6144-45ab-91c0-926cf8ead028",
"SeriesId": "c7882573-116d-4889-8d37-a38d39913d84",
"AccessorID": "4591528e-b59a-4a61-983a-e1e1db06c097",
"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": "1d84168b-5ba0-4312-ac0e-14f8911d537a",
"ScheduledByID": "107723d7-4ed0-4c67-9d18-e3803a389553",
"DeletedDates": [
"2025-07-05T16:14:25Z",
"2025-07-05T16:14:25Z"
],
"ClearedDates": [
"2025-07-05T16:14:25Z",
"2025-07-05T16:14: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-07-05T16:14:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-07-05T16:14:25Z",
"CreateDate": "2025-07-05T16:14:25Z",
"OccurTime": "2025-07-05T16:14:25Z",
"OccurEndTime": "2025-07-05T16:14:25Z",
"StartTime": "2025-07-05T16:14:25Z",
"EndTime": "2025-07-05T16:14:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"48ed11fa-4be0-48dd-a621-954c09a62477",
"5be0ec4f-1224-450a-9d2b-8473f59696e5"
],
"Companies": [
"39542d3a-d069-4871-b0e1-ebacb9e2b613",
"59f3d8bd-680e-4db4-a471-90467d3ac7ac"
],
"Groups": [
"a1ff0f61-230f-436e-87c8-0694dcf88bbc",
"074957b8-cb52-48bd-b107-78bf8e7d34a8"
],
"Opportunities": [
"f19752a6-1a68-4eb5-9f62-81103d506e55",
"60e91a1c-a548-4f32-abd4-002a84aa7ff4"
]
}
}
]