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": [
"713084b7-7626-404a-929c-4f07ec82e064",
"e9613cc4-a0d9-4271-b25c-ead2c1029a8f"
],
"StartRange": "2026-01-10T08:31:13Z",
"EndRange": "2026-01-10T08:31:13Z",
"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": "d6e8f728-b6dd-4deb-88e9-a83c25b9dbfc",
"SeriesId": "4deb8b10-bf6c-4a9b-a87d-d7200012ef62",
"AccessorID": "43611ebc-68f5-4c0a-acb1-dd264cbf874d",
"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": "084e6c62-d689-46a9-a092-86cdcd92dcc3",
"ScheduledByID": "ea7907ab-cae3-4692-8f62-a65c509c23e5",
"DeletedDates": [
"2026-01-10T08:31:13Z",
"2026-01-10T08:31:13Z"
],
"ClearedDates": [
"2026-01-10T08:31:13Z",
"2026-01-10T08:31:13Z"
],
"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-10T08:31:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-10T08:31:13Z",
"CreateDate": "2026-01-10T08:31:13Z",
"OccurTime": "2026-01-10T08:31:13Z",
"OccurEndTime": "2026-01-10T08:31:13Z",
"StartTime": "2026-01-10T08:31:13Z",
"EndTime": "2026-01-10T08:31:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0e2f57f0-e300-4c02-b4e8-d976b31a0a63",
"cf22be1f-fd75-4462-8eda-12dbe201149b"
],
"Companies": [
"1d584aea-1028-4a76-8e49-abd9175f1e55",
"5485ba96-2f3b-4179-98f7-a4af89b53471"
],
"Groups": [
"8ae7cb5e-59b8-4951-a301-f1121659dd9e",
"32800d99-40f3-454e-98ac-c12c240d5c4d"
],
"Opportunities": [
"0e31219d-c98a-4740-8c6a-b46cd445cc04",
"a6ceee2a-5efd-4798-9c61-48dcd1473658"
]
}
},
{
"Id": "d6e8f728-b6dd-4deb-88e9-a83c25b9dbfc",
"SeriesId": "4deb8b10-bf6c-4a9b-a87d-d7200012ef62",
"AccessorID": "43611ebc-68f5-4c0a-acb1-dd264cbf874d",
"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": "084e6c62-d689-46a9-a092-86cdcd92dcc3",
"ScheduledByID": "ea7907ab-cae3-4692-8f62-a65c509c23e5",
"DeletedDates": [
"2026-01-10T08:31:13Z",
"2026-01-10T08:31:13Z"
],
"ClearedDates": [
"2026-01-10T08:31:13Z",
"2026-01-10T08:31:13Z"
],
"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-10T08:31:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-10T08:31:13Z",
"CreateDate": "2026-01-10T08:31:13Z",
"OccurTime": "2026-01-10T08:31:13Z",
"OccurEndTime": "2026-01-10T08:31:13Z",
"StartTime": "2026-01-10T08:31:13Z",
"EndTime": "2026-01-10T08:31:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0e2f57f0-e300-4c02-b4e8-d976b31a0a63",
"cf22be1f-fd75-4462-8eda-12dbe201149b"
],
"Companies": [
"1d584aea-1028-4a76-8e49-abd9175f1e55",
"5485ba96-2f3b-4179-98f7-a4af89b53471"
],
"Groups": [
"8ae7cb5e-59b8-4951-a301-f1121659dd9e",
"32800d99-40f3-454e-98ac-c12c240d5c4d"
],
"Opportunities": [
"0e31219d-c98a-4740-8c6a-b46cd445cc04",
"a6ceee2a-5efd-4798-9c61-48dcd1473658"
]
}
}
]