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": [
"01889a20-f424-478d-989e-c55b13134b9b",
"729816c0-0f4d-4328-b6a8-f9ba5ed54cc2"
],
"StartRange": "2026-05-14T07:56:26Z",
"EndRange": "2026-05-14T07:56:26Z",
"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": "3f3510bd-fa9a-4a04-951e-e6dc3292729c",
"SeriesId": "bcfa350d-dc0a-4c27-9cfd-e40b0b0a5040",
"AccessorID": "fa32bea2-1f70-4bfc-9468-d32be0fbef8c",
"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": "050e5513-91f4-4313-bb2e-cfde785d9616",
"ScheduledByID": "8bdead2f-c0ab-45ee-9e37-3c459de5dae3",
"DeletedDates": [
"2026-05-14T07:56:26Z",
"2026-05-14T07:56:26Z"
],
"ClearedDates": [
"2026-05-14T07:56:26Z",
"2026-05-14T07:56:26Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-14T07:56:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-14T07:56:26Z",
"CreateDate": "2026-05-14T07:56:26Z",
"OccurTime": "2026-05-14T07:56:26Z",
"OccurEndTime": "2026-05-14T07:56:26Z",
"StartTime": "2026-05-14T07:56:26Z",
"EndTime": "2026-05-14T07:56:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bc218b1f-2c83-4989-a63d-02e7a7117ac2",
"5ee6bc59-b5fc-49e2-b1f3-d0af6c41ed06"
],
"Companies": [
"072561dd-6ecd-4d7e-8160-18e62ecd28b6",
"510f16ff-0b1a-45b7-9e60-7b0a3ac24804"
],
"Groups": [
"822ae45e-ad99-4eab-a041-2d0101f79838",
"73c68509-cab3-4b8d-93fa-9582106841ac"
],
"Opportunities": [
"4af4a2b9-1ae1-456b-bfeb-a88603835cf4",
"46802d49-c17b-441b-9de9-53b699ad6112"
]
}
},
{
"Id": "3f3510bd-fa9a-4a04-951e-e6dc3292729c",
"SeriesId": "bcfa350d-dc0a-4c27-9cfd-e40b0b0a5040",
"AccessorID": "fa32bea2-1f70-4bfc-9468-d32be0fbef8c",
"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": "050e5513-91f4-4313-bb2e-cfde785d9616",
"ScheduledByID": "8bdead2f-c0ab-45ee-9e37-3c459de5dae3",
"DeletedDates": [
"2026-05-14T07:56:26Z",
"2026-05-14T07:56:26Z"
],
"ClearedDates": [
"2026-05-14T07:56:26Z",
"2026-05-14T07:56:26Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-14T07:56:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-14T07:56:26Z",
"CreateDate": "2026-05-14T07:56:26Z",
"OccurTime": "2026-05-14T07:56:26Z",
"OccurEndTime": "2026-05-14T07:56:26Z",
"StartTime": "2026-05-14T07:56:26Z",
"EndTime": "2026-05-14T07:56:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bc218b1f-2c83-4989-a63d-02e7a7117ac2",
"5ee6bc59-b5fc-49e2-b1f3-d0af6c41ed06"
],
"Companies": [
"072561dd-6ecd-4d7e-8160-18e62ecd28b6",
"510f16ff-0b1a-45b7-9e60-7b0a3ac24804"
],
"Groups": [
"822ae45e-ad99-4eab-a041-2d0101f79838",
"73c68509-cab3-4b8d-93fa-9582106841ac"
],
"Opportunities": [
"4af4a2b9-1ae1-456b-bfeb-a88603835cf4",
"46802d49-c17b-441b-9de9-53b699ad6112"
]
}
}
]