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": [
"67ef82cb-c26d-4019-abff-730eb6e834dc",
"7ec59547-8d72-4d37-b1eb-8daf94ca55f0"
],
"StartRange": "2025-04-18T04:48:41Z",
"EndRange": "2025-04-18T04:48:41Z",
"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": "8616668a-6f55-434e-a542-d8ebfee8a7fc",
"SeriesId": "3f16f36c-9e87-49ad-9fbf-118e832daea8",
"AccessorID": "6e41c390-ec98-4576-925b-a9466214214b",
"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": "6d1ca561-8996-44a3-b0c7-ad7c173f1ed8",
"ScheduledByID": "94a92086-e323-47f4-9597-d70932c56311",
"DeletedDates": [
"2025-04-18T04:48:41Z",
"2025-04-18T04:48:41Z"
],
"ClearedDates": [
"2025-04-18T04:48:41Z",
"2025-04-18T04:48:41Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-04-18T04:48:41Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-04-18T04:48:41Z",
"CreateDate": "2025-04-18T04:48:41Z",
"OccurTime": "2025-04-18T04:48:41Z",
"OccurEndTime": "2025-04-18T04:48:41Z",
"StartTime": "2025-04-18T04:48:41Z",
"EndTime": "2025-04-18T04:48:41Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0af2ddde-e73f-4a1d-b0a2-aa519c82a4c4",
"a4ab26c8-467f-4d51-9c76-184f32d361c1"
],
"Companies": [
"2448a214-9fa5-4c8c-a947-8a5cbbff1ee3",
"6cc8a559-17f7-4952-bb00-e6c240f15fed"
],
"Groups": [
"98eccbfb-d59e-4bb2-a65a-725d7c990d34",
"6eacf56b-ec76-4c5d-924c-768a3e6298db"
],
"Opportunities": [
"9edbadea-8e08-4e4b-b67d-626cffb4ab5f",
"815159d7-8f29-4b3a-b629-a0308595a9c2"
]
}
},
{
"Id": "8616668a-6f55-434e-a542-d8ebfee8a7fc",
"SeriesId": "3f16f36c-9e87-49ad-9fbf-118e832daea8",
"AccessorID": "6e41c390-ec98-4576-925b-a9466214214b",
"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": "6d1ca561-8996-44a3-b0c7-ad7c173f1ed8",
"ScheduledByID": "94a92086-e323-47f4-9597-d70932c56311",
"DeletedDates": [
"2025-04-18T04:48:41Z",
"2025-04-18T04:48:41Z"
],
"ClearedDates": [
"2025-04-18T04:48:41Z",
"2025-04-18T04:48:41Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-04-18T04:48:41Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-04-18T04:48:41Z",
"CreateDate": "2025-04-18T04:48:41Z",
"OccurTime": "2025-04-18T04:48:41Z",
"OccurEndTime": "2025-04-18T04:48:41Z",
"StartTime": "2025-04-18T04:48:41Z",
"EndTime": "2025-04-18T04:48:41Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0af2ddde-e73f-4a1d-b0a2-aa519c82a4c4",
"a4ab26c8-467f-4d51-9c76-184f32d361c1"
],
"Companies": [
"2448a214-9fa5-4c8c-a947-8a5cbbff1ee3",
"6cc8a559-17f7-4952-bb00-e6c240f15fed"
],
"Groups": [
"98eccbfb-d59e-4bb2-a65a-725d7c990d34",
"6eacf56b-ec76-4c5d-924c-768a3e6298db"
],
"Opportunities": [
"9edbadea-8e08-4e4b-b67d-626cffb4ab5f",
"815159d7-8f29-4b3a-b629-a0308595a9c2"
]
}
}
]