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": [
"da600d0c-fc04-4e50-b7d4-167e788f790e",
"c793a092-689b-4109-9003-d8aee32e524c"
],
"StartRange": "2026-01-18T19:55:36Z",
"EndRange": "2026-01-18T19:55:36Z",
"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": "25b60178-eb86-4f84-8f98-75ee8bdf312a",
"SeriesId": "97f36ef3-b816-4f33-aed0-a6a4e1c2f53b",
"AccessorID": "f9bf45b7-4d3a-4e89-b480-e593a302434c",
"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": "692bfb40-16f8-4c3e-89cd-226268969e33",
"ScheduledByID": "ad95f53e-531f-4ffa-b927-1de49f5939c9",
"DeletedDates": [
"2026-01-18T19:55:36Z",
"2026-01-18T19:55:36Z"
],
"ClearedDates": [
"2026-01-18T19:55:36Z",
"2026-01-18T19:55:36Z"
],
"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-18T19:55:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-18T19:55:36Z",
"CreateDate": "2026-01-18T19:55:36Z",
"OccurTime": "2026-01-18T19:55:36Z",
"OccurEndTime": "2026-01-18T19:55:36Z",
"StartTime": "2026-01-18T19:55:36Z",
"EndTime": "2026-01-18T19:55:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ad07cde4-4c83-4410-8804-163cae40bf71",
"8f6cc8e4-73e9-4896-8543-97a56900516e"
],
"Companies": [
"b8f925ab-28a4-47eb-8847-4020fbf0df26",
"592085a7-d116-4a52-8349-02667aeae905"
],
"Groups": [
"9c6abf7c-3ade-428e-8e9d-5b7f1cb0ad62",
"2044e057-3a61-4b21-9ec0-abcd5167ee46"
],
"Opportunities": [
"b5be95ab-e749-4bcc-aa00-499bc3b6c5cf",
"505d6f3e-0c84-4c23-a6ff-28bec9592600"
]
}
},
{
"Id": "25b60178-eb86-4f84-8f98-75ee8bdf312a",
"SeriesId": "97f36ef3-b816-4f33-aed0-a6a4e1c2f53b",
"AccessorID": "f9bf45b7-4d3a-4e89-b480-e593a302434c",
"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": "692bfb40-16f8-4c3e-89cd-226268969e33",
"ScheduledByID": "ad95f53e-531f-4ffa-b927-1de49f5939c9",
"DeletedDates": [
"2026-01-18T19:55:36Z",
"2026-01-18T19:55:36Z"
],
"ClearedDates": [
"2026-01-18T19:55:36Z",
"2026-01-18T19:55:36Z"
],
"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-18T19:55:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-18T19:55:36Z",
"CreateDate": "2026-01-18T19:55:36Z",
"OccurTime": "2026-01-18T19:55:36Z",
"OccurEndTime": "2026-01-18T19:55:36Z",
"StartTime": "2026-01-18T19:55:36Z",
"EndTime": "2026-01-18T19:55:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ad07cde4-4c83-4410-8804-163cae40bf71",
"8f6cc8e4-73e9-4896-8543-97a56900516e"
],
"Companies": [
"b8f925ab-28a4-47eb-8847-4020fbf0df26",
"592085a7-d116-4a52-8349-02667aeae905"
],
"Groups": [
"9c6abf7c-3ade-428e-8e9d-5b7f1cb0ad62",
"2044e057-3a61-4b21-9ec0-abcd5167ee46"
],
"Opportunities": [
"b5be95ab-e749-4bcc-aa00-499bc3b6c5cf",
"505d6f3e-0c84-4c23-a6ff-28bec9592600"
]
}
}
]