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": [
"66557ca9-64e7-416b-a688-dad5ffdcbf0d",
"225b6cee-49d1-4b14-8d94-67c3b17755ff"
],
"StartRange": "2025-11-25T17:56:59Z",
"EndRange": "2025-11-25T17:56:59Z",
"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": "4515d163-1e0d-4dfa-b402-2425b1bbd5c8",
"SeriesId": "995437b1-d153-4c2d-99e8-583cd7e09b4a",
"AccessorID": "843661bb-56a9-4f8b-a44d-bdbf2e05c2e4",
"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": "92ae16a6-aafd-447a-b4d8-0eb7aa4c4bb5",
"ScheduledByID": "4145232b-c9c7-4847-98cf-a21e6c467d24",
"DeletedDates": [
"2025-11-25T17:56:59Z",
"2025-11-25T17:56:59Z"
],
"ClearedDates": [
"2025-11-25T17:56:59Z",
"2025-11-25T17:56:59Z"
],
"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-25T17:56:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-25T17:56:59Z",
"CreateDate": "2025-11-25T17:56:59Z",
"OccurTime": "2025-11-25T17:56:59Z",
"OccurEndTime": "2025-11-25T17:56:59Z",
"StartTime": "2025-11-25T17:56:59Z",
"EndTime": "2025-11-25T17:56:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"75fad3f2-0eda-4bd8-a2c4-7d988d743439",
"7aae3b92-a5aa-442e-9080-81cbdff31a39"
],
"Companies": [
"307bfe07-ddf9-41c6-9f69-ea8ae4fee590",
"456924a3-2847-40aa-9f02-291aea65cf3f"
],
"Groups": [
"fa37c058-da41-4e79-9389-8a89dc382f4e",
"96ddcea1-3f6a-4dc9-a6dc-96739fd6b26d"
],
"Opportunities": [
"aac043b2-ec3b-422c-a807-da05c2e0a6c3",
"436b8039-e93c-4b93-bbc2-5eb32d13792c"
]
}
},
{
"Id": "4515d163-1e0d-4dfa-b402-2425b1bbd5c8",
"SeriesId": "995437b1-d153-4c2d-99e8-583cd7e09b4a",
"AccessorID": "843661bb-56a9-4f8b-a44d-bdbf2e05c2e4",
"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": "92ae16a6-aafd-447a-b4d8-0eb7aa4c4bb5",
"ScheduledByID": "4145232b-c9c7-4847-98cf-a21e6c467d24",
"DeletedDates": [
"2025-11-25T17:56:59Z",
"2025-11-25T17:56:59Z"
],
"ClearedDates": [
"2025-11-25T17:56:59Z",
"2025-11-25T17:56:59Z"
],
"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-25T17:56:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-25T17:56:59Z",
"CreateDate": "2025-11-25T17:56:59Z",
"OccurTime": "2025-11-25T17:56:59Z",
"OccurEndTime": "2025-11-25T17:56:59Z",
"StartTime": "2025-11-25T17:56:59Z",
"EndTime": "2025-11-25T17:56:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"75fad3f2-0eda-4bd8-a2c4-7d988d743439",
"7aae3b92-a5aa-442e-9080-81cbdff31a39"
],
"Companies": [
"307bfe07-ddf9-41c6-9f69-ea8ae4fee590",
"456924a3-2847-40aa-9f02-291aea65cf3f"
],
"Groups": [
"fa37c058-da41-4e79-9389-8a89dc382f4e",
"96ddcea1-3f6a-4dc9-a6dc-96739fd6b26d"
],
"Opportunities": [
"aac043b2-ec3b-422c-a807-da05c2e0a6c3",
"436b8039-e93c-4b93-bbc2-5eb32d13792c"
]
}
}
]