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": [
"d5762010-9613-42fc-9d7e-44a4f5966586",
"1484db7d-7e3b-4799-84f9-13e82240141d"
],
"StartRange": "2026-01-02T05:28:27Z",
"EndRange": "2026-01-02T05:28:27Z",
"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": "a9100689-177c-4238-8c6c-8cb8ff01934b",
"SeriesId": "1e5398a9-a2bb-49dc-af0b-2a3aa7803ac1",
"AccessorID": "ab53ff4e-8c8e-4bf3-9e4d-ac4c4f2f719e",
"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": "323d6c25-22f1-496c-971f-7b588409d6fa",
"ScheduledByID": "8451d297-b892-4da7-8d36-b8df6998f138",
"DeletedDates": [
"2026-01-02T05:28:27Z",
"2026-01-02T05:28:27Z"
],
"ClearedDates": [
"2026-01-02T05:28:27Z",
"2026-01-02T05:28:27Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-02T05:28:27Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-02T05:28:27Z",
"CreateDate": "2026-01-02T05:28:27Z",
"OccurTime": "2026-01-02T05:28:27Z",
"OccurEndTime": "2026-01-02T05:28:27Z",
"StartTime": "2026-01-02T05:28:27Z",
"EndTime": "2026-01-02T05:28:27Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aaa0ad95-39da-4b6d-b512-f0905d285743",
"b0ddd039-f005-421e-8a89-30afe6153839"
],
"Companies": [
"7198fbe5-7274-4cae-b964-79a7ac8d2750",
"0f745af4-7016-4c89-bc07-ec31be54c596"
],
"Groups": [
"c31ba879-e5a1-4dc5-9efb-7bafebdf3798",
"82a6d0d1-e25d-4dd5-a135-486a254e5507"
],
"Opportunities": [
"b18e87cc-ba92-4b03-b2ca-0f28871480e4",
"328faae4-5e36-459e-b63b-2ede484c1a89"
]
}
},
{
"Id": "a9100689-177c-4238-8c6c-8cb8ff01934b",
"SeriesId": "1e5398a9-a2bb-49dc-af0b-2a3aa7803ac1",
"AccessorID": "ab53ff4e-8c8e-4bf3-9e4d-ac4c4f2f719e",
"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": "323d6c25-22f1-496c-971f-7b588409d6fa",
"ScheduledByID": "8451d297-b892-4da7-8d36-b8df6998f138",
"DeletedDates": [
"2026-01-02T05:28:27Z",
"2026-01-02T05:28:27Z"
],
"ClearedDates": [
"2026-01-02T05:28:27Z",
"2026-01-02T05:28:27Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-02T05:28:27Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-02T05:28:27Z",
"CreateDate": "2026-01-02T05:28:27Z",
"OccurTime": "2026-01-02T05:28:27Z",
"OccurEndTime": "2026-01-02T05:28:27Z",
"StartTime": "2026-01-02T05:28:27Z",
"EndTime": "2026-01-02T05:28:27Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aaa0ad95-39da-4b6d-b512-f0905d285743",
"b0ddd039-f005-421e-8a89-30afe6153839"
],
"Companies": [
"7198fbe5-7274-4cae-b964-79a7ac8d2750",
"0f745af4-7016-4c89-bc07-ec31be54c596"
],
"Groups": [
"c31ba879-e5a1-4dc5-9efb-7bafebdf3798",
"82a6d0d1-e25d-4dd5-a135-486a254e5507"
],
"Opportunities": [
"b18e87cc-ba92-4b03-b2ca-0f28871480e4",
"328faae4-5e36-459e-b63b-2ede484c1a89"
]
}
}
]