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": [
"c16e3d85-83b1-45aa-a308-b0a6ea2e1efc",
"b6a37783-8b0d-4cc2-9dcb-57e5e9e67012"
],
"StartRange": "2025-06-03T07:39:14Z",
"EndRange": "2025-06-03T07:39:14Z",
"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": "f92d8d00-9fc4-46b7-9d41-70395bd6b009",
"SeriesId": "e686142f-2ba7-4948-a946-e409a9d0ef5c",
"AccessorID": "7f53b928-60ea-4676-a492-b5cb1a3add4e",
"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": "71a8186d-bd23-42a2-b0b9-bb96df0a1627",
"ScheduledByID": "1e52ff6a-08ad-4a99-88a5-9dd58382abfa",
"DeletedDates": [
"2025-06-03T07:39:14Z",
"2025-06-03T07:39:14Z"
],
"ClearedDates": [
"2025-06-03T07:39:14Z",
"2025-06-03T07:39:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-06-03T07:39:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-06-03T07:39:14Z",
"CreateDate": "2025-06-03T07:39:14Z",
"OccurTime": "2025-06-03T07:39:14Z",
"OccurEndTime": "2025-06-03T07:39:14Z",
"StartTime": "2025-06-03T07:39:14Z",
"EndTime": "2025-06-03T07:39:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6986110c-1faa-412f-ba5e-2852a9d6b31c",
"2cb024d8-6671-481c-8ef8-345a2356094e"
],
"Companies": [
"e19b82f2-b5ae-4bc8-8329-749543c9bdc3",
"764bcca8-5f1f-4163-a0ac-49dd2d227ac6"
],
"Groups": [
"b4b57344-bcc7-4500-96c5-aad480fcd529",
"656a3652-c898-4729-af7e-e5a762ecddf7"
],
"Opportunities": [
"6ef79f4d-f934-4e0a-98ea-4785156ccf9f",
"de48970e-f4d7-4362-a79b-55d4f8271967"
]
}
},
{
"Id": "f92d8d00-9fc4-46b7-9d41-70395bd6b009",
"SeriesId": "e686142f-2ba7-4948-a946-e409a9d0ef5c",
"AccessorID": "7f53b928-60ea-4676-a492-b5cb1a3add4e",
"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": "71a8186d-bd23-42a2-b0b9-bb96df0a1627",
"ScheduledByID": "1e52ff6a-08ad-4a99-88a5-9dd58382abfa",
"DeletedDates": [
"2025-06-03T07:39:14Z",
"2025-06-03T07:39:14Z"
],
"ClearedDates": [
"2025-06-03T07:39:14Z",
"2025-06-03T07:39:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-06-03T07:39:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-06-03T07:39:14Z",
"CreateDate": "2025-06-03T07:39:14Z",
"OccurTime": "2025-06-03T07:39:14Z",
"OccurEndTime": "2025-06-03T07:39:14Z",
"StartTime": "2025-06-03T07:39:14Z",
"EndTime": "2025-06-03T07:39:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6986110c-1faa-412f-ba5e-2852a9d6b31c",
"2cb024d8-6671-481c-8ef8-345a2356094e"
],
"Companies": [
"e19b82f2-b5ae-4bc8-8329-749543c9bdc3",
"764bcca8-5f1f-4163-a0ac-49dd2d227ac6"
],
"Groups": [
"b4b57344-bcc7-4500-96c5-aad480fcd529",
"656a3652-c898-4729-af7e-e5a762ecddf7"
],
"Opportunities": [
"6ef79f4d-f934-4e0a-98ea-4785156ccf9f",
"de48970e-f4d7-4362-a79b-55d4f8271967"
]
}
}
]