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": [
"7a622a0e-0c08-463d-837d-e111e219dd76",
"8c6386e9-31dd-4b5a-965e-a50bf1660014"
],
"StartRange": "2026-05-01T01:15:13Z",
"EndRange": "2026-05-01T01:15:13Z",
"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": "909d1730-67c7-417c-9c8a-730e58d02e8d",
"SeriesId": "89e39a19-773f-4187-8aa7-3e6a3d372abb",
"AccessorID": "f3953deb-9a48-41d2-9268-69d88411273d",
"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": "27403718-f002-41a5-9d7a-76c2cd9d3510",
"ScheduledByID": "13c05b11-f4c4-4490-8e09-441ae55af9e7",
"DeletedDates": [
"2026-05-01T01:15:13Z",
"2026-05-01T01:15:13Z"
],
"ClearedDates": [
"2026-05-01T01:15:13Z",
"2026-05-01T01:15:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-01T01:15:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-01T01:15:13Z",
"CreateDate": "2026-05-01T01:15:13Z",
"OccurTime": "2026-05-01T01:15:13Z",
"OccurEndTime": "2026-05-01T01:15:13Z",
"StartTime": "2026-05-01T01:15:13Z",
"EndTime": "2026-05-01T01:15:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e4419fb5-c147-47b1-bc24-de76cfdf890f",
"3d9cfb9b-91e0-4031-af83-dbac02e8ed75"
],
"Companies": [
"ca684e7b-8fcf-452d-9009-9e77bcb5bb9f",
"f1589abd-0ef4-4168-8e0d-645fb47eed3e"
],
"Groups": [
"b4bf68a7-95b9-45d7-881b-9be1efcca867",
"372c003f-883f-413f-9077-8ad344a2cc6c"
],
"Opportunities": [
"35773baf-d7a7-48de-ae0d-86fbe1c2c0ab",
"7b090244-49db-4090-8561-d4552e4795b5"
]
}
},
{
"Id": "909d1730-67c7-417c-9c8a-730e58d02e8d",
"SeriesId": "89e39a19-773f-4187-8aa7-3e6a3d372abb",
"AccessorID": "f3953deb-9a48-41d2-9268-69d88411273d",
"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": "27403718-f002-41a5-9d7a-76c2cd9d3510",
"ScheduledByID": "13c05b11-f4c4-4490-8e09-441ae55af9e7",
"DeletedDates": [
"2026-05-01T01:15:13Z",
"2026-05-01T01:15:13Z"
],
"ClearedDates": [
"2026-05-01T01:15:13Z",
"2026-05-01T01:15:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-01T01:15:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-01T01:15:13Z",
"CreateDate": "2026-05-01T01:15:13Z",
"OccurTime": "2026-05-01T01:15:13Z",
"OccurEndTime": "2026-05-01T01:15:13Z",
"StartTime": "2026-05-01T01:15:13Z",
"EndTime": "2026-05-01T01:15:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e4419fb5-c147-47b1-bc24-de76cfdf890f",
"3d9cfb9b-91e0-4031-af83-dbac02e8ed75"
],
"Companies": [
"ca684e7b-8fcf-452d-9009-9e77bcb5bb9f",
"f1589abd-0ef4-4168-8e0d-645fb47eed3e"
],
"Groups": [
"b4bf68a7-95b9-45d7-881b-9be1efcca867",
"372c003f-883f-413f-9077-8ad344a2cc6c"
],
"Opportunities": [
"35773baf-d7a7-48de-ae0d-86fbe1c2c0ab",
"7b090244-49db-4090-8561-d4552e4795b5"
]
}
}
]