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": [
"03f8473d-5dcc-48eb-ad3f-e1096a302e74",
"eeecbb9a-9979-4517-adf4-5081f299e5ec"
],
"StartRange": "2025-09-13T07:08:45Z",
"EndRange": "2025-09-13T07:08:45Z",
"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": "35bef447-21e1-4fe1-9056-d80b11bba6c8",
"SeriesId": "8e854cc6-3139-4323-be8d-b1ecce7bd14c",
"AccessorID": "2bda86bc-0fcc-47e7-8133-9f7084e82bc8",
"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": "2dd98213-0fd8-48e6-b10c-9f479459f23c",
"ScheduledByID": "cbffc7a3-bb11-4de4-a34f-1ba93fc90e3d",
"DeletedDates": [
"2025-09-13T07:08:45Z",
"2025-09-13T07:08:45Z"
],
"ClearedDates": [
"2025-09-13T07:08:45Z",
"2025-09-13T07:08:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-09-13T07:08:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-09-13T07:08:45Z",
"CreateDate": "2025-09-13T07:08:45Z",
"OccurTime": "2025-09-13T07:08:45Z",
"OccurEndTime": "2025-09-13T07:08:45Z",
"StartTime": "2025-09-13T07:08:45Z",
"EndTime": "2025-09-13T07:08:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e2ce664e-52d4-4d47-899e-8c0bbaf42148",
"749802fd-d9ea-4754-825c-1ffca6f93d53"
],
"Companies": [
"c64341a1-8191-4048-9920-b730abddcf46",
"04a9ac19-4d75-4839-8039-efc7a557376b"
],
"Groups": [
"555491f3-e2dc-48a8-b0e9-e813cde2a7a8",
"784f3222-9526-4342-8e35-2d2a990ab5f3"
],
"Opportunities": [
"a58ac283-171b-432c-a9d3-d0d567bb01cb",
"0150da00-3617-4e68-8963-a15652d4affc"
]
}
},
{
"Id": "35bef447-21e1-4fe1-9056-d80b11bba6c8",
"SeriesId": "8e854cc6-3139-4323-be8d-b1ecce7bd14c",
"AccessorID": "2bda86bc-0fcc-47e7-8133-9f7084e82bc8",
"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": "2dd98213-0fd8-48e6-b10c-9f479459f23c",
"ScheduledByID": "cbffc7a3-bb11-4de4-a34f-1ba93fc90e3d",
"DeletedDates": [
"2025-09-13T07:08:45Z",
"2025-09-13T07:08:45Z"
],
"ClearedDates": [
"2025-09-13T07:08:45Z",
"2025-09-13T07:08:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-09-13T07:08:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-09-13T07:08:45Z",
"CreateDate": "2025-09-13T07:08:45Z",
"OccurTime": "2025-09-13T07:08:45Z",
"OccurEndTime": "2025-09-13T07:08:45Z",
"StartTime": "2025-09-13T07:08:45Z",
"EndTime": "2025-09-13T07:08:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e2ce664e-52d4-4d47-899e-8c0bbaf42148",
"749802fd-d9ea-4754-825c-1ffca6f93d53"
],
"Companies": [
"c64341a1-8191-4048-9920-b730abddcf46",
"04a9ac19-4d75-4839-8039-efc7a557376b"
],
"Groups": [
"555491f3-e2dc-48a8-b0e9-e813cde2a7a8",
"784f3222-9526-4342-8e35-2d2a990ab5f3"
],
"Opportunities": [
"a58ac283-171b-432c-a9d3-d0d567bb01cb",
"0150da00-3617-4e68-8963-a15652d4affc"
]
}
}
]