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": [
"f56b92bb-dca9-4ea3-b640-17cc08894656",
"4a49d45b-5550-400b-b614-51bde5a4407c"
],
"StartRange": "2025-04-16T21:50:32Z",
"EndRange": "2025-04-16T21:50:32Z",
"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": "99ca9f64-186f-4810-9d06-e96cae864898",
"SeriesId": "b8c2414e-0512-4229-a572-9c27028e2288",
"AccessorID": "b08538bc-895a-43f6-8864-b8e8da2d1cb2",
"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": "42bb9dc2-7f19-42cd-9e9d-312b70986de2",
"ScheduledByID": "2c1382f8-56b2-48d2-ab32-03e161991110",
"DeletedDates": [
"2025-04-16T21:50:32Z",
"2025-04-16T21:50:32Z"
],
"ClearedDates": [
"2025-04-16T21:50:32Z",
"2025-04-16T21:50:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-04-16T21:50:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-04-16T21:50:32Z",
"CreateDate": "2025-04-16T21:50:32Z",
"OccurTime": "2025-04-16T21:50:32Z",
"OccurEndTime": "2025-04-16T21:50:32Z",
"StartTime": "2025-04-16T21:50:32Z",
"EndTime": "2025-04-16T21:50:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ff21de85-ccef-4fd4-806a-df9a1b506b11",
"e79cbab3-7ada-4be7-ac2d-b106af579ff3"
],
"Companies": [
"dd6452bc-e4f1-4083-81dc-a536421ff5f6",
"e36cc4f7-d6e8-41ba-8a47-99daa88b94c9"
],
"Groups": [
"90783315-cb07-41fb-b30a-d8a240cffb35",
"d340d7de-a7d2-4666-a6fe-0a09c15393c3"
],
"Opportunities": [
"b03b3045-404f-4b99-819d-770c22168364",
"d0d6181b-a114-4f4a-b1c9-8ebb8ff5c5b6"
]
}
},
{
"Id": "99ca9f64-186f-4810-9d06-e96cae864898",
"SeriesId": "b8c2414e-0512-4229-a572-9c27028e2288",
"AccessorID": "b08538bc-895a-43f6-8864-b8e8da2d1cb2",
"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": "42bb9dc2-7f19-42cd-9e9d-312b70986de2",
"ScheduledByID": "2c1382f8-56b2-48d2-ab32-03e161991110",
"DeletedDates": [
"2025-04-16T21:50:32Z",
"2025-04-16T21:50:32Z"
],
"ClearedDates": [
"2025-04-16T21:50:32Z",
"2025-04-16T21:50:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-04-16T21:50:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-04-16T21:50:32Z",
"CreateDate": "2025-04-16T21:50:32Z",
"OccurTime": "2025-04-16T21:50:32Z",
"OccurEndTime": "2025-04-16T21:50:32Z",
"StartTime": "2025-04-16T21:50:32Z",
"EndTime": "2025-04-16T21:50:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ff21de85-ccef-4fd4-806a-df9a1b506b11",
"e79cbab3-7ada-4be7-ac2d-b106af579ff3"
],
"Companies": [
"dd6452bc-e4f1-4083-81dc-a536421ff5f6",
"e36cc4f7-d6e8-41ba-8a47-99daa88b94c9"
],
"Groups": [
"90783315-cb07-41fb-b30a-d8a240cffb35",
"d340d7de-a7d2-4666-a6fe-0a09c15393c3"
],
"Opportunities": [
"b03b3045-404f-4b99-819d-770c22168364",
"d0d6181b-a114-4f4a-b1c9-8ebb8ff5c5b6"
]
}
}
]