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": [
"bde56df4-1d51-4823-81db-0c427f2b8f0e",
"5838eac4-7705-45fe-8241-bc4003e92ad2"
],
"StartRange": "2026-01-23T10:34:45Z",
"EndRange": "2026-01-23T10:34:45Z",
"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": "ac54d7e6-4a3a-4edb-90f3-33eeabb3f75f",
"SeriesId": "899c02d2-1504-4c36-a068-253b619cfbb4",
"AccessorID": "16eb3688-949a-4b78-9f57-4737af146672",
"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": "b659a2de-addf-4385-bb81-62c96ca1f6d6",
"ScheduledByID": "c8f1729c-8893-49e0-a405-082f9e10d0c8",
"DeletedDates": [
"2026-01-23T10:34:45Z",
"2026-01-23T10:34:45Z"
],
"ClearedDates": [
"2026-01-23T10:34:45Z",
"2026-01-23T10:34:45Z"
],
"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-23T10:34:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-23T10:34:45Z",
"CreateDate": "2026-01-23T10:34:45Z",
"OccurTime": "2026-01-23T10:34:45Z",
"OccurEndTime": "2026-01-23T10:34:45Z",
"StartTime": "2026-01-23T10:34:45Z",
"EndTime": "2026-01-23T10:34:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"40cf4e7e-4887-4e59-813b-a3c8e28143d6",
"9cb37927-9e1b-4618-b16d-38b3571553b0"
],
"Companies": [
"31fb1041-4544-4828-9d1b-84ebd9e80b78",
"09909451-7fd9-4778-8bb3-b9c9b0782cc2"
],
"Groups": [
"84121dda-ebf2-4c82-ba13-d4194ff8871a",
"96ecd2a2-47d8-4793-98e5-442301d8c5e9"
],
"Opportunities": [
"8cccafb3-9d11-48cc-b14e-87f45af9a486",
"56eba85f-d463-494f-bdc7-f6a0d9237244"
]
}
},
{
"Id": "ac54d7e6-4a3a-4edb-90f3-33eeabb3f75f",
"SeriesId": "899c02d2-1504-4c36-a068-253b619cfbb4",
"AccessorID": "16eb3688-949a-4b78-9f57-4737af146672",
"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": "b659a2de-addf-4385-bb81-62c96ca1f6d6",
"ScheduledByID": "c8f1729c-8893-49e0-a405-082f9e10d0c8",
"DeletedDates": [
"2026-01-23T10:34:45Z",
"2026-01-23T10:34:45Z"
],
"ClearedDates": [
"2026-01-23T10:34:45Z",
"2026-01-23T10:34:45Z"
],
"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-23T10:34:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-23T10:34:45Z",
"CreateDate": "2026-01-23T10:34:45Z",
"OccurTime": "2026-01-23T10:34:45Z",
"OccurEndTime": "2026-01-23T10:34:45Z",
"StartTime": "2026-01-23T10:34:45Z",
"EndTime": "2026-01-23T10:34:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"40cf4e7e-4887-4e59-813b-a3c8e28143d6",
"9cb37927-9e1b-4618-b16d-38b3571553b0"
],
"Companies": [
"31fb1041-4544-4828-9d1b-84ebd9e80b78",
"09909451-7fd9-4778-8bb3-b9c9b0782cc2"
],
"Groups": [
"84121dda-ebf2-4c82-ba13-d4194ff8871a",
"96ecd2a2-47d8-4793-98e5-442301d8c5e9"
],
"Opportunities": [
"8cccafb3-9d11-48cc-b14e-87f45af9a486",
"56eba85f-d463-494f-bdc7-f6a0d9237244"
]
}
}
]