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": [
"6c6fbcd4-eed7-4289-a808-df13dc06e47b",
"1ccf9df9-221b-460e-9d3c-a915e522ea12"
],
"StartRange": "2025-11-12T01:18:56Z",
"EndRange": "2025-11-12T01:18:56Z",
"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": "cd1c556a-1ecb-43b2-a1b5-94b50c06a679",
"SeriesId": "78f818ea-4aea-4249-9dc7-14b0081a3ff4",
"AccessorID": "be5a507e-9950-42b3-89a4-6d3882d6b8c8",
"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": "66600dd3-a5f9-4226-9772-8316c4bdcaaf",
"ScheduledByID": "a42f04d6-718b-4577-9a41-7212183843e4",
"DeletedDates": [
"2025-11-12T01:18:56Z",
"2025-11-12T01:18:56Z"
],
"ClearedDates": [
"2025-11-12T01:18:56Z",
"2025-11-12T01:18:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-12T01:18:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-12T01:18:56Z",
"CreateDate": "2025-11-12T01:18:56Z",
"OccurTime": "2025-11-12T01:18:56Z",
"OccurEndTime": "2025-11-12T01:18:56Z",
"StartTime": "2025-11-12T01:18:56Z",
"EndTime": "2025-11-12T01:18:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"20847e59-6ff7-498e-9317-ba31cae5b958",
"703acec9-3b38-49c6-9b85-ecefba2fb6f8"
],
"Companies": [
"69c60a17-4a9c-461f-880d-7b051d0e60ef",
"fbdd7bc3-0473-4dfb-8846-d65ba15e9a6b"
],
"Groups": [
"61ee9324-42f1-4f28-8afe-cb2f27a9bbdf",
"449a7fcc-5921-4b59-9e2f-bbd7b382858b"
],
"Opportunities": [
"db8eb2bc-281c-4280-bc3d-2f5238a58b72",
"af72dccd-3a2b-41fb-a30c-4c9e57a4125a"
]
}
},
{
"Id": "cd1c556a-1ecb-43b2-a1b5-94b50c06a679",
"SeriesId": "78f818ea-4aea-4249-9dc7-14b0081a3ff4",
"AccessorID": "be5a507e-9950-42b3-89a4-6d3882d6b8c8",
"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": "66600dd3-a5f9-4226-9772-8316c4bdcaaf",
"ScheduledByID": "a42f04d6-718b-4577-9a41-7212183843e4",
"DeletedDates": [
"2025-11-12T01:18:56Z",
"2025-11-12T01:18:56Z"
],
"ClearedDates": [
"2025-11-12T01:18:56Z",
"2025-11-12T01:18:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-12T01:18:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-12T01:18:56Z",
"CreateDate": "2025-11-12T01:18:56Z",
"OccurTime": "2025-11-12T01:18:56Z",
"OccurEndTime": "2025-11-12T01:18:56Z",
"StartTime": "2025-11-12T01:18:56Z",
"EndTime": "2025-11-12T01:18:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"20847e59-6ff7-498e-9317-ba31cae5b958",
"703acec9-3b38-49c6-9b85-ecefba2fb6f8"
],
"Companies": [
"69c60a17-4a9c-461f-880d-7b051d0e60ef",
"fbdd7bc3-0473-4dfb-8846-d65ba15e9a6b"
],
"Groups": [
"61ee9324-42f1-4f28-8afe-cb2f27a9bbdf",
"449a7fcc-5921-4b59-9e2f-bbd7b382858b"
],
"Opportunities": [
"db8eb2bc-281c-4280-bc3d-2f5238a58b72",
"af72dccd-3a2b-41fb-a30c-4c9e57a4125a"
]
}
}
]