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": [
"70f1db50-1a9a-4af1-a870-ebe198e3c711",
"7d63e248-a54d-44e2-9fe9-8a4039076bb9"
],
"StartRange": "2025-07-05T09:22:48Z",
"EndRange": "2025-07-05T09:22:48Z",
"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": "0cff300a-43f1-42a2-9860-2378fe45549f",
"SeriesId": "c40ff9de-48aa-452b-9748-3689b13542de",
"AccessorID": "112f6351-9f48-4257-afc3-a83a6cc83c0a",
"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": "ba5ca3e9-4870-4d6e-a645-d55f596dec0d",
"ScheduledByID": "58f6188d-7a4d-490a-bf97-13b820884f5c",
"DeletedDates": [
"2025-07-05T09:22:48Z",
"2025-07-05T09:22:48Z"
],
"ClearedDates": [
"2025-07-05T09:22:48Z",
"2025-07-05T09:22:48Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-07-05T09:22:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-07-05T09:22:48Z",
"CreateDate": "2025-07-05T09:22:48Z",
"OccurTime": "2025-07-05T09:22:48Z",
"OccurEndTime": "2025-07-05T09:22:48Z",
"StartTime": "2025-07-05T09:22:48Z",
"EndTime": "2025-07-05T09:22:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9dce0867-1441-4176-822e-c73a45104dc9",
"57e70068-2e2a-403a-a8d6-5d90f606bc3a"
],
"Companies": [
"75faab16-4f9d-4911-beda-e50b07a345a5",
"1e1e2671-7f92-4b03-b988-8ba01d6142d7"
],
"Groups": [
"01193c16-6a31-4b62-87f5-ee558dd6c3bf",
"d899c3e4-6dbd-4c54-9f01-5387b51f2ef9"
],
"Opportunities": [
"87abe8d2-949e-455d-a93b-55f03f8d19a6",
"0894c800-b61c-4d43-a86c-59ff36b555e5"
]
}
},
{
"Id": "0cff300a-43f1-42a2-9860-2378fe45549f",
"SeriesId": "c40ff9de-48aa-452b-9748-3689b13542de",
"AccessorID": "112f6351-9f48-4257-afc3-a83a6cc83c0a",
"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": "ba5ca3e9-4870-4d6e-a645-d55f596dec0d",
"ScheduledByID": "58f6188d-7a4d-490a-bf97-13b820884f5c",
"DeletedDates": [
"2025-07-05T09:22:48Z",
"2025-07-05T09:22:48Z"
],
"ClearedDates": [
"2025-07-05T09:22:48Z",
"2025-07-05T09:22:48Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-07-05T09:22:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-07-05T09:22:48Z",
"CreateDate": "2025-07-05T09:22:48Z",
"OccurTime": "2025-07-05T09:22:48Z",
"OccurEndTime": "2025-07-05T09:22:48Z",
"StartTime": "2025-07-05T09:22:48Z",
"EndTime": "2025-07-05T09:22:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9dce0867-1441-4176-822e-c73a45104dc9",
"57e70068-2e2a-403a-a8d6-5d90f606bc3a"
],
"Companies": [
"75faab16-4f9d-4911-beda-e50b07a345a5",
"1e1e2671-7f92-4b03-b988-8ba01d6142d7"
],
"Groups": [
"01193c16-6a31-4b62-87f5-ee558dd6c3bf",
"d899c3e4-6dbd-4c54-9f01-5387b51f2ef9"
],
"Opportunities": [
"87abe8d2-949e-455d-a93b-55f03f8d19a6",
"0894c800-b61c-4d43-a86c-59ff36b555e5"
]
}
}
]