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": [
"84b89598-3c17-46a0-9819-1d8bcce7aef1",
"90b73a74-a54e-4d24-9914-62817ef25d7b"
],
"StartRange": "2025-11-21T13:56:42Z",
"EndRange": "2025-11-21T13:56:42Z",
"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": "3b64e439-9f14-4574-a075-46961038bd29",
"SeriesId": "0bc264ac-50f0-49d2-aa4f-2df47d5ae59c",
"AccessorID": "a87648b0-d8f4-4e54-8f80-ae93fa4b54e9",
"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": "af57cda6-7e9b-4741-94e7-3984920444e4",
"ScheduledByID": "4945460b-d96d-4b2a-a098-dc37eeab10ce",
"DeletedDates": [
"2025-11-21T13:56:42Z",
"2025-11-21T13:56:42Z"
],
"ClearedDates": [
"2025-11-21T13:56:42Z",
"2025-11-21T13:56:42Z"
],
"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-21T13:56:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-21T13:56:42Z",
"CreateDate": "2025-11-21T13:56:42Z",
"OccurTime": "2025-11-21T13:56:42Z",
"OccurEndTime": "2025-11-21T13:56:42Z",
"StartTime": "2025-11-21T13:56:42Z",
"EndTime": "2025-11-21T13:56:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1d20343b-18a5-4781-8a1f-2f8200ebfcc1",
"5aabcd36-3313-4a50-b035-8dbf805e856f"
],
"Companies": [
"e656a6ce-022d-4133-8a2a-8023c5c07a06",
"763795f1-b6dc-46eb-919b-d4850265c434"
],
"Groups": [
"2eaea28f-8528-4c1e-a7a2-9bae56aa0869",
"c1a14b60-e056-4781-919e-a99502302e93"
],
"Opportunities": [
"72ef0b8b-e0a0-42bc-aeee-d070d38ad245",
"8a53b7ec-7452-4878-b500-49ccc6c4d0d0"
]
}
},
{
"Id": "3b64e439-9f14-4574-a075-46961038bd29",
"SeriesId": "0bc264ac-50f0-49d2-aa4f-2df47d5ae59c",
"AccessorID": "a87648b0-d8f4-4e54-8f80-ae93fa4b54e9",
"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": "af57cda6-7e9b-4741-94e7-3984920444e4",
"ScheduledByID": "4945460b-d96d-4b2a-a098-dc37eeab10ce",
"DeletedDates": [
"2025-11-21T13:56:42Z",
"2025-11-21T13:56:42Z"
],
"ClearedDates": [
"2025-11-21T13:56:42Z",
"2025-11-21T13:56:42Z"
],
"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-21T13:56:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-21T13:56:42Z",
"CreateDate": "2025-11-21T13:56:42Z",
"OccurTime": "2025-11-21T13:56:42Z",
"OccurEndTime": "2025-11-21T13:56:42Z",
"StartTime": "2025-11-21T13:56:42Z",
"EndTime": "2025-11-21T13:56:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1d20343b-18a5-4781-8a1f-2f8200ebfcc1",
"5aabcd36-3313-4a50-b035-8dbf805e856f"
],
"Companies": [
"e656a6ce-022d-4133-8a2a-8023c5c07a06",
"763795f1-b6dc-46eb-919b-d4850265c434"
],
"Groups": [
"2eaea28f-8528-4c1e-a7a2-9bae56aa0869",
"c1a14b60-e056-4781-919e-a99502302e93"
],
"Opportunities": [
"72ef0b8b-e0a0-42bc-aeee-d070d38ad245",
"8a53b7ec-7452-4878-b500-49ccc6c4d0d0"
]
}
}
]