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": [
"432eb5ad-8ef7-4d28-8d6a-f037c0723e21",
"9c445e4a-31b7-4658-8d06-417261f2408f"
],
"StartRange": "2025-12-04T15:01:44Z",
"EndRange": "2025-12-04T15:01:44Z",
"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": "ad20255b-ad4c-410f-b658-88207ef16560",
"SeriesId": "5c0a015c-fba3-43a8-9f99-52c16c105a3e",
"AccessorID": "f4a14735-e7ab-43ce-a50e-5d69c91dfd57",
"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": "a372002b-6020-42f8-bdf3-b2a6466dd106",
"ScheduledByID": "cc9f3db5-aace-480b-89c9-7a8adb0ea017",
"DeletedDates": [
"2025-12-04T15:01:44Z",
"2025-12-04T15:01:44Z"
],
"ClearedDates": [
"2025-12-04T15:01:44Z",
"2025-12-04T15:01:44Z"
],
"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-04T15:01:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-04T15:01:44Z",
"CreateDate": "2025-12-04T15:01:44Z",
"OccurTime": "2025-12-04T15:01:44Z",
"OccurEndTime": "2025-12-04T15:01:44Z",
"StartTime": "2025-12-04T15:01:44Z",
"EndTime": "2025-12-04T15:01:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0f58805a-8a09-4b9d-8b24-244beb3e2ae1",
"58b91fbb-0134-4905-ad1f-c964cdaf13ee"
],
"Companies": [
"5267e560-704e-4c3a-8c64-893930a07e0f",
"323717a2-b3ad-40eb-a5c9-4fd43bcfdc6a"
],
"Groups": [
"6a32a77c-8015-480f-bcfd-49a81e1133d9",
"2c9d0527-fcea-497f-baf4-ad2ef414220f"
],
"Opportunities": [
"1bab018e-cc74-4a2f-9a76-3af965ca2859",
"701055ef-cb3f-41ad-8d15-21a5b1b4b96d"
]
}
},
{
"Id": "ad20255b-ad4c-410f-b658-88207ef16560",
"SeriesId": "5c0a015c-fba3-43a8-9f99-52c16c105a3e",
"AccessorID": "f4a14735-e7ab-43ce-a50e-5d69c91dfd57",
"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": "a372002b-6020-42f8-bdf3-b2a6466dd106",
"ScheduledByID": "cc9f3db5-aace-480b-89c9-7a8adb0ea017",
"DeletedDates": [
"2025-12-04T15:01:44Z",
"2025-12-04T15:01:44Z"
],
"ClearedDates": [
"2025-12-04T15:01:44Z",
"2025-12-04T15:01:44Z"
],
"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-04T15:01:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-04T15:01:44Z",
"CreateDate": "2025-12-04T15:01:44Z",
"OccurTime": "2025-12-04T15:01:44Z",
"OccurEndTime": "2025-12-04T15:01:44Z",
"StartTime": "2025-12-04T15:01:44Z",
"EndTime": "2025-12-04T15:01:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0f58805a-8a09-4b9d-8b24-244beb3e2ae1",
"58b91fbb-0134-4905-ad1f-c964cdaf13ee"
],
"Companies": [
"5267e560-704e-4c3a-8c64-893930a07e0f",
"323717a2-b3ad-40eb-a5c9-4fd43bcfdc6a"
],
"Groups": [
"6a32a77c-8015-480f-bcfd-49a81e1133d9",
"2c9d0527-fcea-497f-baf4-ad2ef414220f"
],
"Opportunities": [
"1bab018e-cc74-4a2f-9a76-3af965ca2859",
"701055ef-cb3f-41ad-8d15-21a5b1b4b96d"
]
}
}
]