POST api/TaskList
Retrieve tasklists for one or more users in the database
Request Information
URI Parameters
None.
Body Parameters
TaskListParameterName | 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": [ "64c582a5-ac6d-4b3d-b9fd-aa1f11d4ed52", "014bfbfd-28c9-455f-9c82-764e65ead1c6" ], "StartRange": "2025-10-16T14:45:24Z", "EndRange": "2025-10-16T14:45:24Z", "IncludeCleared": true, "FirstOccurrenceOnly": true }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ActivityName | 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": "7783a4e0-b001-4737-a269-082995e6759e", "SeriesId": "5daaafde-2b02-4ca6-9457-025ef336a457", "AccessorID": "a1a216b9-fbd8-4edd-8b9e-46f17881e434", "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": "3336f8e2-1c5a-4013-b249-23f317e60f80", "ScheduledByID": "dd9f5589-928d-42f9-9e42-01d4c163abfc", "DeletedDates": [ "2025-10-16T14:45:24Z", "2025-10-16T14:45:24Z" ], "ClearedDates": [ "2025-10-16T14:45:24Z", "2025-10-16T14:45:24Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-10-16T14:45:24Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-10-16T14:45:24Z", "CreateDate": "2025-10-16T14:45:24Z", "OccurTime": "2025-10-16T14:45:24Z", "OccurEndTime": "2025-10-16T14:45:24Z", "StartTime": "2025-10-16T14:45:24Z", "EndTime": "2025-10-16T14:45:24Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "6c6ff330-0d41-4695-b985-562c30fa8115", "826ec374-4af5-4887-86fc-4395f1fe7f24" ], "Companies": [ "8552e13f-7dac-4407-a07f-ce47d836db3d", "006d38c5-f2fa-4949-9f5a-198042dc0f95" ], "Groups": [ "def6252a-c531-40f9-a364-a2f1ff3aa583", "d0a8425d-d245-4b31-898e-05f129275bae" ], "Opportunities": [ "57c1badd-9f94-4a2f-b80e-6e90e719fe2a", "95e10594-2eee-403c-ad01-512d55201d2b" ] } }, { "Id": "7783a4e0-b001-4737-a269-082995e6759e", "SeriesId": "5daaafde-2b02-4ca6-9457-025ef336a457", "AccessorID": "a1a216b9-fbd8-4edd-8b9e-46f17881e434", "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": "3336f8e2-1c5a-4013-b249-23f317e60f80", "ScheduledByID": "dd9f5589-928d-42f9-9e42-01d4c163abfc", "DeletedDates": [ "2025-10-16T14:45:24Z", "2025-10-16T14:45:24Z" ], "ClearedDates": [ "2025-10-16T14:45:24Z", "2025-10-16T14:45:24Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-10-16T14:45:24Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-10-16T14:45:24Z", "CreateDate": "2025-10-16T14:45:24Z", "OccurTime": "2025-10-16T14:45:24Z", "OccurEndTime": "2025-10-16T14:45:24Z", "StartTime": "2025-10-16T14:45:24Z", "EndTime": "2025-10-16T14:45:24Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "6c6ff330-0d41-4695-b985-562c30fa8115", "826ec374-4af5-4887-86fc-4395f1fe7f24" ], "Companies": [ "8552e13f-7dac-4407-a07f-ce47d836db3d", "006d38c5-f2fa-4949-9f5a-198042dc0f95" ], "Groups": [ "def6252a-c531-40f9-a364-a2f1ff3aa583", "d0a8425d-d245-4b31-898e-05f129275bae" ], "Opportunities": [ "57c1badd-9f94-4a2f-b80e-6e90e719fe2a", "95e10594-2eee-403c-ad01-512d55201d2b" ] } } ]