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": [
"4e8b5185-96a6-4e68-b596-41b981d0d3e3",
"0aeed218-892c-4ac1-baf2-e47dcfd16d36"
],
"StartRange": "2026-01-16T03:55:08Z",
"EndRange": "2026-01-16T03:55:08Z",
"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": "8a44f9ae-5bf9-467b-b5ba-7868b220e2ca",
"SeriesId": "bd1ed7c7-7ce8-4a62-a4d3-6b43b55f9a1b",
"AccessorID": "87748fb6-c929-4c9c-aa36-67d124e28b69",
"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": "ca80a959-f06a-45b9-a2dc-936720b1ab31",
"ScheduledByID": "1e242feb-c9f5-450a-871d-ec4196990af6",
"DeletedDates": [
"2026-01-16T03:55:08Z",
"2026-01-16T03:55:08Z"
],
"ClearedDates": [
"2026-01-16T03:55:08Z",
"2026-01-16T03:55:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-16T03:55:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-16T03:55:08Z",
"CreateDate": "2026-01-16T03:55:08Z",
"OccurTime": "2026-01-16T03:55:08Z",
"OccurEndTime": "2026-01-16T03:55:08Z",
"StartTime": "2026-01-16T03:55:08Z",
"EndTime": "2026-01-16T03:55:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f611a4bd-6284-40dc-81f4-47839ace2b82",
"9c2ac29e-6a80-47a3-ac87-1b437211f95c"
],
"Companies": [
"336c74bf-4d1f-4abc-a053-330971f7b8ee",
"55397b06-a63c-4273-a013-c9d87d06fabf"
],
"Groups": [
"aba9aa54-88a7-4735-b129-5bf19a0de930",
"ed56cb6f-8f5c-4769-adf3-4b7bce49d682"
],
"Opportunities": [
"f2011a53-5ac0-4f41-b136-0a58da8cc8ee",
"4f97bf1c-b32d-4ebf-b4e1-2e2ae832d3d8"
]
}
},
{
"Id": "8a44f9ae-5bf9-467b-b5ba-7868b220e2ca",
"SeriesId": "bd1ed7c7-7ce8-4a62-a4d3-6b43b55f9a1b",
"AccessorID": "87748fb6-c929-4c9c-aa36-67d124e28b69",
"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": "ca80a959-f06a-45b9-a2dc-936720b1ab31",
"ScheduledByID": "1e242feb-c9f5-450a-871d-ec4196990af6",
"DeletedDates": [
"2026-01-16T03:55:08Z",
"2026-01-16T03:55:08Z"
],
"ClearedDates": [
"2026-01-16T03:55:08Z",
"2026-01-16T03:55:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-16T03:55:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-16T03:55:08Z",
"CreateDate": "2026-01-16T03:55:08Z",
"OccurTime": "2026-01-16T03:55:08Z",
"OccurEndTime": "2026-01-16T03:55:08Z",
"StartTime": "2026-01-16T03:55:08Z",
"EndTime": "2026-01-16T03:55:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f611a4bd-6284-40dc-81f4-47839ace2b82",
"9c2ac29e-6a80-47a3-ac87-1b437211f95c"
],
"Companies": [
"336c74bf-4d1f-4abc-a053-330971f7b8ee",
"55397b06-a63c-4273-a013-c9d87d06fabf"
],
"Groups": [
"aba9aa54-88a7-4735-b129-5bf19a0de930",
"ed56cb6f-8f5c-4769-adf3-4b7bce49d682"
],
"Opportunities": [
"f2011a53-5ac0-4f41-b136-0a58da8cc8ee",
"4f97bf1c-b32d-4ebf-b4e1-2e2ae832d3d8"
]
}
}
]