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": [
"a206a3b4-2b64-4cdf-974a-a65ae4ec9923",
"c97019c6-aa9a-4f8d-8ca8-81e51c8841d7"
],
"StartRange": "2025-11-15T16:06:56Z",
"EndRange": "2025-11-15T16:06:56Z",
"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": "c399c0d2-7117-416a-a94a-0733fb2597de",
"SeriesId": "bdcf5589-82b4-44bf-b9e6-14109e13babe",
"AccessorID": "27742aaf-b272-430b-b139-6566742cfc98",
"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": "ddcd5d82-abe5-4482-a685-9b6b03285262",
"ScheduledByID": "5fce6466-1d16-4bf1-9ad5-bf34b8f04216",
"DeletedDates": [
"2025-11-15T16:06:56Z",
"2025-11-15T16:06:56Z"
],
"ClearedDates": [
"2025-11-15T16:06:56Z",
"2025-11-15T16:06:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-15T16:06:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-15T16:06:56Z",
"CreateDate": "2025-11-15T16:06:56Z",
"OccurTime": "2025-11-15T16:06:56Z",
"OccurEndTime": "2025-11-15T16:06:56Z",
"StartTime": "2025-11-15T16:06:56Z",
"EndTime": "2025-11-15T16:06:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"066dbe63-a30a-4b1c-b6e6-bedc655bd425",
"dd4159c2-c51a-4286-a2b6-0f8db86b2fca"
],
"Companies": [
"722fe0a9-d869-4523-a521-b44bfbea1a9c",
"c3d6a79b-c5b6-42e2-a425-9985bdd8f40e"
],
"Groups": [
"8346a441-da17-413a-a8bc-e9a3c168def8",
"774390da-e70f-4f5c-beef-568b1cbb8924"
],
"Opportunities": [
"1d667fa5-5f4b-43b8-8493-c467c1887c80",
"517afad0-1356-4cfd-bb4d-5106cce7477d"
]
}
},
{
"Id": "c399c0d2-7117-416a-a94a-0733fb2597de",
"SeriesId": "bdcf5589-82b4-44bf-b9e6-14109e13babe",
"AccessorID": "27742aaf-b272-430b-b139-6566742cfc98",
"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": "ddcd5d82-abe5-4482-a685-9b6b03285262",
"ScheduledByID": "5fce6466-1d16-4bf1-9ad5-bf34b8f04216",
"DeletedDates": [
"2025-11-15T16:06:56Z",
"2025-11-15T16:06:56Z"
],
"ClearedDates": [
"2025-11-15T16:06:56Z",
"2025-11-15T16:06:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-15T16:06:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-15T16:06:56Z",
"CreateDate": "2025-11-15T16:06:56Z",
"OccurTime": "2025-11-15T16:06:56Z",
"OccurEndTime": "2025-11-15T16:06:56Z",
"StartTime": "2025-11-15T16:06:56Z",
"EndTime": "2025-11-15T16:06:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"066dbe63-a30a-4b1c-b6e6-bedc655bd425",
"dd4159c2-c51a-4286-a2b6-0f8db86b2fca"
],
"Companies": [
"722fe0a9-d869-4523-a521-b44bfbea1a9c",
"c3d6a79b-c5b6-42e2-a425-9985bdd8f40e"
],
"Groups": [
"8346a441-da17-413a-a8bc-e9a3c168def8",
"774390da-e70f-4f5c-beef-568b1cbb8924"
],
"Opportunities": [
"1d667fa5-5f4b-43b8-8493-c467c1887c80",
"517afad0-1356-4cfd-bb4d-5106cce7477d"
]
}
}
]