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": [
"672fcc64-b3d9-40e1-9d9e-b30a62074cf1",
"f746a6a1-553f-4487-91c3-43a7d69afcfe"
],
"StartRange": "2025-10-13T09:25:34Z",
"EndRange": "2025-10-13T09:25:34Z",
"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": "52e9b740-00a4-46fa-9aba-f8bb6adfbc23",
"SeriesId": "70686b6e-7df8-4727-8475-5fd1721cee9e",
"AccessorID": "72163625-3398-445d-9677-061da2536abf",
"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": "f070c0bf-b2d8-401b-8f78-9693bdc5e5eb",
"ScheduledByID": "56821ae9-416a-438a-aeba-c7b7d7d198c0",
"DeletedDates": [
"2025-10-13T09:25:34Z",
"2025-10-13T09:25:34Z"
],
"ClearedDates": [
"2025-10-13T09:25:34Z",
"2025-10-13T09:25:34Z"
],
"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-13T09:25:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-10-13T09:25:35Z",
"CreateDate": "2025-10-13T09:25:35Z",
"OccurTime": "2025-10-13T09:25:35Z",
"OccurEndTime": "2025-10-13T09:25:35Z",
"StartTime": "2025-10-13T09:25:35Z",
"EndTime": "2025-10-13T09:25:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"79f6b1bd-f650-4544-8e84-9831dc3d38fd",
"58466357-d3b8-409e-92ef-253203b44269"
],
"Companies": [
"be002de7-24ae-40b0-8b8f-b96e1f75a2ce",
"2aee6b59-e8ab-48bf-a72b-ee7fd706f24c"
],
"Groups": [
"0cc66ab8-ba1a-4acc-8a41-736323310074",
"4118bd78-26cf-45ae-9fb5-98d13609d356"
],
"Opportunities": [
"5cfc0a9b-0910-4edf-bf98-08d0d8d89c6d",
"cb40d634-4112-4cea-9047-6958744f6b80"
]
}
},
{
"Id": "52e9b740-00a4-46fa-9aba-f8bb6adfbc23",
"SeriesId": "70686b6e-7df8-4727-8475-5fd1721cee9e",
"AccessorID": "72163625-3398-445d-9677-061da2536abf",
"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": "f070c0bf-b2d8-401b-8f78-9693bdc5e5eb",
"ScheduledByID": "56821ae9-416a-438a-aeba-c7b7d7d198c0",
"DeletedDates": [
"2025-10-13T09:25:34Z",
"2025-10-13T09:25:34Z"
],
"ClearedDates": [
"2025-10-13T09:25:34Z",
"2025-10-13T09:25:34Z"
],
"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-13T09:25:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-10-13T09:25:35Z",
"CreateDate": "2025-10-13T09:25:35Z",
"OccurTime": "2025-10-13T09:25:35Z",
"OccurEndTime": "2025-10-13T09:25:35Z",
"StartTime": "2025-10-13T09:25:35Z",
"EndTime": "2025-10-13T09:25:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"79f6b1bd-f650-4544-8e84-9831dc3d38fd",
"58466357-d3b8-409e-92ef-253203b44269"
],
"Companies": [
"be002de7-24ae-40b0-8b8f-b96e1f75a2ce",
"2aee6b59-e8ab-48bf-a72b-ee7fd706f24c"
],
"Groups": [
"0cc66ab8-ba1a-4acc-8a41-736323310074",
"4118bd78-26cf-45ae-9fb5-98d13609d356"
],
"Opportunities": [
"5cfc0a9b-0910-4edf-bf98-08d0d8d89c6d",
"cb40d634-4112-4cea-9047-6958744f6b80"
]
}
}
]