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": [
"a583f0c3-04da-43d8-9eb1-296d7a97bb31",
"76a79040-0ed2-4dc5-8754-df5ca3c16837"
],
"StartRange": "2026-01-05T01:23:08Z",
"EndRange": "2026-01-05T01:23: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": "70f3e143-4f49-4c4f-983f-b1545fe1f216",
"SeriesId": "6b3bfbcf-f0c2-4066-bc9a-47d628578fda",
"AccessorID": "cebcad6f-840c-4dff-86db-f4e85a7c58be",
"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": "508017dc-472e-4091-9da3-5b450058e4a2",
"ScheduledByID": "a2ec018d-1afd-492c-894e-6632ff7f29c6",
"DeletedDates": [
"2026-01-05T01:23:08Z",
"2026-01-05T01:23:08Z"
],
"ClearedDates": [
"2026-01-05T01:23:08Z",
"2026-01-05T01:23: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-05T01:23:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-05T01:23:08Z",
"CreateDate": "2026-01-05T01:23:08Z",
"OccurTime": "2026-01-05T01:23:08Z",
"OccurEndTime": "2026-01-05T01:23:08Z",
"StartTime": "2026-01-05T01:23:08Z",
"EndTime": "2026-01-05T01:23:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"5b8d7aa1-3198-4709-b064-85fee58f08a3",
"fe62880c-7f29-4cd9-9cad-fd62b4f1e303"
],
"Companies": [
"227f4ec5-a7fc-4fc2-802a-71a3dca827d6",
"5976ff72-4c00-49dd-a61b-bb21d8af9e34"
],
"Groups": [
"67ba46d0-a530-4ca5-9658-b8c08cf4c745",
"590fcb87-79be-4fcd-ab99-85354d869e75"
],
"Opportunities": [
"b38909b4-0f8f-4c94-a637-14381d4de5f7",
"a4dd6b33-7590-4438-9e56-f2a47bbeb09d"
]
}
},
{
"Id": "70f3e143-4f49-4c4f-983f-b1545fe1f216",
"SeriesId": "6b3bfbcf-f0c2-4066-bc9a-47d628578fda",
"AccessorID": "cebcad6f-840c-4dff-86db-f4e85a7c58be",
"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": "508017dc-472e-4091-9da3-5b450058e4a2",
"ScheduledByID": "a2ec018d-1afd-492c-894e-6632ff7f29c6",
"DeletedDates": [
"2026-01-05T01:23:08Z",
"2026-01-05T01:23:08Z"
],
"ClearedDates": [
"2026-01-05T01:23:08Z",
"2026-01-05T01:23: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-05T01:23:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-05T01:23:08Z",
"CreateDate": "2026-01-05T01:23:08Z",
"OccurTime": "2026-01-05T01:23:08Z",
"OccurEndTime": "2026-01-05T01:23:08Z",
"StartTime": "2026-01-05T01:23:08Z",
"EndTime": "2026-01-05T01:23:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"5b8d7aa1-3198-4709-b064-85fee58f08a3",
"fe62880c-7f29-4cd9-9cad-fd62b4f1e303"
],
"Companies": [
"227f4ec5-a7fc-4fc2-802a-71a3dca827d6",
"5976ff72-4c00-49dd-a61b-bb21d8af9e34"
],
"Groups": [
"67ba46d0-a530-4ca5-9658-b8c08cf4c745",
"590fcb87-79be-4fcd-ab99-85354d869e75"
],
"Opportunities": [
"b38909b4-0f8f-4c94-a637-14381d4de5f7",
"a4dd6b33-7590-4438-9e56-f2a47bbeb09d"
]
}
}
]