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": [
"5cd58e8c-eb3d-4e39-a52a-2dc9fdbef2c8",
"79f6a0c8-92ca-4f52-b733-d1079e0619d7"
],
"StartRange": "2026-01-11T15:12:46Z",
"EndRange": "2026-01-11T15:12:46Z",
"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": "17c0c6c7-fab0-43d3-98ca-152362c114db",
"SeriesId": "e6898db5-8b27-475d-a339-2a01017d1da6",
"AccessorID": "dc8fad0f-29f7-4754-92e9-576ddcba369f",
"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": "a4c767dd-2e01-43db-800f-e0615010c5c2",
"ScheduledByID": "3bf81a58-b32f-497f-a6db-1824d7e70602",
"DeletedDates": [
"2026-01-11T15:12:46Z",
"2026-01-11T15:12:46Z"
],
"ClearedDates": [
"2026-01-11T15:12:46Z",
"2026-01-11T15:12:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-11T15:12:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-11T15:12:46Z",
"CreateDate": "2026-01-11T15:12:46Z",
"OccurTime": "2026-01-11T15:12:46Z",
"OccurEndTime": "2026-01-11T15:12:46Z",
"StartTime": "2026-01-11T15:12:46Z",
"EndTime": "2026-01-11T15:12:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"14b4da32-81f8-45ce-b1a2-99c58bd61736",
"14bf8807-0482-4d35-a689-932e72c53794"
],
"Companies": [
"d51508a2-ee4b-41b2-b969-092728b86877",
"8d53980d-f124-42f5-89ce-9b1d3869a6b5"
],
"Groups": [
"78823d26-16b8-44fa-9938-8c23bab7f1c5",
"fa8003b3-0515-450b-8f91-6a4840b8f05d"
],
"Opportunities": [
"5ffdd8c3-b9d1-49ef-840c-05a4ca35c8f5",
"c135ac1a-66c8-4d6d-be48-685c91ad1b31"
]
}
},
{
"Id": "17c0c6c7-fab0-43d3-98ca-152362c114db",
"SeriesId": "e6898db5-8b27-475d-a339-2a01017d1da6",
"AccessorID": "dc8fad0f-29f7-4754-92e9-576ddcba369f",
"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": "a4c767dd-2e01-43db-800f-e0615010c5c2",
"ScheduledByID": "3bf81a58-b32f-497f-a6db-1824d7e70602",
"DeletedDates": [
"2026-01-11T15:12:46Z",
"2026-01-11T15:12:46Z"
],
"ClearedDates": [
"2026-01-11T15:12:46Z",
"2026-01-11T15:12:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-11T15:12:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-11T15:12:46Z",
"CreateDate": "2026-01-11T15:12:46Z",
"OccurTime": "2026-01-11T15:12:46Z",
"OccurEndTime": "2026-01-11T15:12:46Z",
"StartTime": "2026-01-11T15:12:46Z",
"EndTime": "2026-01-11T15:12:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"14b4da32-81f8-45ce-b1a2-99c58bd61736",
"14bf8807-0482-4d35-a689-932e72c53794"
],
"Companies": [
"d51508a2-ee4b-41b2-b969-092728b86877",
"8d53980d-f124-42f5-89ce-9b1d3869a6b5"
],
"Groups": [
"78823d26-16b8-44fa-9938-8c23bab7f1c5",
"fa8003b3-0515-450b-8f91-6a4840b8f05d"
],
"Opportunities": [
"5ffdd8c3-b9d1-49ef-840c-05a4ca35c8f5",
"c135ac1a-66c8-4d6d-be48-685c91ad1b31"
]
}
}
]