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": [
"86ace671-2e17-4d1c-a841-87bedc8bc81b",
"c4bcfa01-fcb7-4bda-9093-9fe85d7b69ea"
],
"StartRange": "2025-11-16T20:39:43Z",
"EndRange": "2025-11-16T20:39:43Z",
"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": "63cc2ec1-e77f-4a17-b35d-13c2bfca3764",
"SeriesId": "bfbdb316-f852-45fe-8f01-f0b3fb48a7b9",
"AccessorID": "e1712463-79aa-4f9e-90c6-23f7ed5116cf",
"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": "b327235b-90c1-45ee-8123-e004eaaddae3",
"ScheduledByID": "7fff249a-8066-40f3-89ce-b93c590cba5e",
"DeletedDates": [
"2025-11-16T20:39:43Z",
"2025-11-16T20:39:43Z"
],
"ClearedDates": [
"2025-11-16T20:39:43Z",
"2025-11-16T20:39:43Z"
],
"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-16T20:39:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-16T20:39:43Z",
"CreateDate": "2025-11-16T20:39:43Z",
"OccurTime": "2025-11-16T20:39:43Z",
"OccurEndTime": "2025-11-16T20:39:43Z",
"StartTime": "2025-11-16T20:39:43Z",
"EndTime": "2025-11-16T20:39:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c331477c-1f5c-428c-b9e4-4c8e597eeccf",
"5fbe758f-04a3-4a1e-802a-4aa9ecd92f36"
],
"Companies": [
"bb901920-9ad2-40a6-8540-397dc9faeb31",
"dc6260a5-d760-4889-be5f-c5d19bcc5111"
],
"Groups": [
"40ac0cc3-17f2-4110-b137-5a24fdece1fd",
"3e62e11f-ce9a-4cb1-ad45-5273f868e691"
],
"Opportunities": [
"a5ffd535-ba49-4429-9292-9aa0a121b5d7",
"41acd4f5-ba2e-4c30-8e85-99e39f24bdc7"
]
}
},
{
"Id": "63cc2ec1-e77f-4a17-b35d-13c2bfca3764",
"SeriesId": "bfbdb316-f852-45fe-8f01-f0b3fb48a7b9",
"AccessorID": "e1712463-79aa-4f9e-90c6-23f7ed5116cf",
"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": "b327235b-90c1-45ee-8123-e004eaaddae3",
"ScheduledByID": "7fff249a-8066-40f3-89ce-b93c590cba5e",
"DeletedDates": [
"2025-11-16T20:39:43Z",
"2025-11-16T20:39:43Z"
],
"ClearedDates": [
"2025-11-16T20:39:43Z",
"2025-11-16T20:39:43Z"
],
"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-16T20:39:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-16T20:39:43Z",
"CreateDate": "2025-11-16T20:39:43Z",
"OccurTime": "2025-11-16T20:39:43Z",
"OccurEndTime": "2025-11-16T20:39:43Z",
"StartTime": "2025-11-16T20:39:43Z",
"EndTime": "2025-11-16T20:39:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c331477c-1f5c-428c-b9e4-4c8e597eeccf",
"5fbe758f-04a3-4a1e-802a-4aa9ecd92f36"
],
"Companies": [
"bb901920-9ad2-40a6-8540-397dc9faeb31",
"dc6260a5-d760-4889-be5f-c5d19bcc5111"
],
"Groups": [
"40ac0cc3-17f2-4110-b137-5a24fdece1fd",
"3e62e11f-ce9a-4cb1-ad45-5273f868e691"
],
"Opportunities": [
"a5ffd535-ba49-4429-9292-9aa0a121b5d7",
"41acd4f5-ba2e-4c30-8e85-99e39f24bdc7"
]
}
}
]