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": [
"9fd03f70-8bad-479b-a1c3-d381f2b9a5aa",
"95c00225-3140-40fc-8555-c17f84a36bf7"
],
"StartRange": "2026-04-27T23:01:09Z",
"EndRange": "2026-04-27T23:01:09Z",
"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": "750ef015-0f64-4410-a2f5-41cd9f36177f",
"SeriesId": "668ccad1-abc3-4661-9c05-ff8b65628849",
"AccessorID": "31c57b78-67a1-4b08-b258-879b6807991b",
"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": "28a7795c-eb4f-4b3d-9e8e-5455a7c219d5",
"ScheduledByID": "1bbb8911-f44f-4d91-ba2a-cc8869c1615b",
"DeletedDates": [
"2026-04-27T23:01:09Z",
"2026-04-27T23:01:09Z"
],
"ClearedDates": [
"2026-04-27T23:01:09Z",
"2026-04-27T23:01:09Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-27T23:01:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T23:01:09Z",
"CreateDate": "2026-04-27T23:01:09Z",
"OccurTime": "2026-04-27T23:01:09Z",
"OccurEndTime": "2026-04-27T23:01:09Z",
"StartTime": "2026-04-27T23:01:09Z",
"EndTime": "2026-04-27T23:01:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3fbe9a92-50e2-4c37-b464-baf5f41662a4",
"2b8b8205-6819-430f-af3c-cd51d0d7a3a7"
],
"Companies": [
"335a7294-5ee8-4b70-9def-d078b039cf6c",
"51c14cb8-3219-4bcb-bde0-cf2647eaa4ff"
],
"Groups": [
"fb110aaa-700a-427c-914c-4852b765290f",
"91e4dfc5-1c97-41f7-b2a7-a324b885d26b"
],
"Opportunities": [
"91ac46a1-e43c-4f0e-91ed-18e25451392f",
"24ce6f83-c12b-4560-a72a-dfb486288e28"
]
}
},
{
"Id": "750ef015-0f64-4410-a2f5-41cd9f36177f",
"SeriesId": "668ccad1-abc3-4661-9c05-ff8b65628849",
"AccessorID": "31c57b78-67a1-4b08-b258-879b6807991b",
"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": "28a7795c-eb4f-4b3d-9e8e-5455a7c219d5",
"ScheduledByID": "1bbb8911-f44f-4d91-ba2a-cc8869c1615b",
"DeletedDates": [
"2026-04-27T23:01:09Z",
"2026-04-27T23:01:09Z"
],
"ClearedDates": [
"2026-04-27T23:01:09Z",
"2026-04-27T23:01:09Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-27T23:01:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T23:01:09Z",
"CreateDate": "2026-04-27T23:01:09Z",
"OccurTime": "2026-04-27T23:01:09Z",
"OccurEndTime": "2026-04-27T23:01:09Z",
"StartTime": "2026-04-27T23:01:09Z",
"EndTime": "2026-04-27T23:01:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3fbe9a92-50e2-4c37-b464-baf5f41662a4",
"2b8b8205-6819-430f-af3c-cd51d0d7a3a7"
],
"Companies": [
"335a7294-5ee8-4b70-9def-d078b039cf6c",
"51c14cb8-3219-4bcb-bde0-cf2647eaa4ff"
],
"Groups": [
"fb110aaa-700a-427c-914c-4852b765290f",
"91e4dfc5-1c97-41f7-b2a7-a324b885d26b"
],
"Opportunities": [
"91ac46a1-e43c-4f0e-91ed-18e25451392f",
"24ce6f83-c12b-4560-a72a-dfb486288e28"
]
}
}
]