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": [
"e44018b3-4086-428e-a23d-42408c541b52",
"1498a189-faa6-4d74-b3da-1bfceba882d7"
],
"StartRange": "2026-03-28T05:12:01Z",
"EndRange": "2026-03-28T05:12:01Z",
"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": "6a1b089d-55cb-4514-b229-e1143756288f",
"SeriesId": "d3043e16-335c-4443-af28-29c0d35a3926",
"AccessorID": "fbcb9d71-82e1-4c02-997e-705aab809a88",
"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": "66433db1-8a6b-43fb-94c3-c6859b4f5402",
"ScheduledByID": "3a65df21-4bab-4f5f-bfd3-d5b7e0ecc4a5",
"DeletedDates": [
"2026-03-28T05:12:01Z",
"2026-03-28T05:12:01Z"
],
"ClearedDates": [
"2026-03-28T05:12:01Z",
"2026-03-28T05:12:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-28T05:12:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-28T05:12:01Z",
"CreateDate": "2026-03-28T05:12:01Z",
"OccurTime": "2026-03-28T05:12:01Z",
"OccurEndTime": "2026-03-28T05:12:01Z",
"StartTime": "2026-03-28T05:12:01Z",
"EndTime": "2026-03-28T05:12:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"95007e8e-41d4-431d-a1a2-8f7dd2eca204",
"ce8de981-2cd4-4476-8195-6295c976d0d5"
],
"Companies": [
"6b13228b-b7cf-45af-8d26-6fd26054c36c",
"9a5e20f4-b6ad-49ca-aba0-6336964a28b0"
],
"Groups": [
"f7098b9b-11c5-4d78-b8fa-3b9f983ead91",
"4d528a1a-3ee3-4e91-9801-de559f8787aa"
],
"Opportunities": [
"d564a1b1-fbb3-43f7-a3d0-7f8e3667d871",
"dc838d7f-c245-4f8b-a8ca-7c8d89d80965"
]
}
},
{
"Id": "6a1b089d-55cb-4514-b229-e1143756288f",
"SeriesId": "d3043e16-335c-4443-af28-29c0d35a3926",
"AccessorID": "fbcb9d71-82e1-4c02-997e-705aab809a88",
"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": "66433db1-8a6b-43fb-94c3-c6859b4f5402",
"ScheduledByID": "3a65df21-4bab-4f5f-bfd3-d5b7e0ecc4a5",
"DeletedDates": [
"2026-03-28T05:12:01Z",
"2026-03-28T05:12:01Z"
],
"ClearedDates": [
"2026-03-28T05:12:01Z",
"2026-03-28T05:12:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-28T05:12:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-28T05:12:01Z",
"CreateDate": "2026-03-28T05:12:01Z",
"OccurTime": "2026-03-28T05:12:01Z",
"OccurEndTime": "2026-03-28T05:12:01Z",
"StartTime": "2026-03-28T05:12:01Z",
"EndTime": "2026-03-28T05:12:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"95007e8e-41d4-431d-a1a2-8f7dd2eca204",
"ce8de981-2cd4-4476-8195-6295c976d0d5"
],
"Companies": [
"6b13228b-b7cf-45af-8d26-6fd26054c36c",
"9a5e20f4-b6ad-49ca-aba0-6336964a28b0"
],
"Groups": [
"f7098b9b-11c5-4d78-b8fa-3b9f983ead91",
"4d528a1a-3ee3-4e91-9801-de559f8787aa"
],
"Opportunities": [
"d564a1b1-fbb3-43f7-a3d0-7f8e3667d871",
"dc838d7f-c245-4f8b-a8ca-7c8d89d80965"
]
}
}
]