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": [
"0d2f31ca-1a70-4258-b6f4-2cf3bc8d9b5d",
"2dfaec79-d798-432d-8d15-fd79d1bf2e9d"
],
"StartRange": "2026-01-29T00:57:39Z",
"EndRange": "2026-01-29T00:57:39Z",
"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": "303bfd97-cc8c-4ca7-9aa9-eca1778dfcea",
"SeriesId": "e8ea8b03-2fcf-47d3-8fa3-20c6c2dc21cc",
"AccessorID": "d0d7c4ff-225d-445a-83cb-faa06bc6a250",
"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": "89870da0-4141-445a-830e-53976e0c13ea",
"ScheduledByID": "5c3b608f-1df4-4d62-8b74-0ca185388cb8",
"DeletedDates": [
"2026-01-29T00:57:39Z",
"2026-01-29T00:57:39Z"
],
"ClearedDates": [
"2026-01-29T00:57:39Z",
"2026-01-29T00:57:39Z"
],
"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-29T00:57:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-29T00:57:39Z",
"CreateDate": "2026-01-29T00:57:39Z",
"OccurTime": "2026-01-29T00:57:39Z",
"OccurEndTime": "2026-01-29T00:57:39Z",
"StartTime": "2026-01-29T00:57:39Z",
"EndTime": "2026-01-29T00:57:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f8ad0230-e9e9-4e6e-9043-7f868ffcf423",
"c5dced63-9339-498e-bb4b-05b096f9580b"
],
"Companies": [
"366acd0a-c6b2-4a56-9a83-82cb32cdbab8",
"00ac97d0-f0fc-40ce-9d97-8c021da42d08"
],
"Groups": [
"d28453ff-35b0-420d-a713-2aa7496a271a",
"5fe83237-5328-47b0-9c25-7d09a62d2148"
],
"Opportunities": [
"d3c941fc-1cc3-47e9-9b9c-21521acbb835",
"a715a29d-7ffc-4201-82d7-56a87b5ebbe7"
]
}
},
{
"Id": "303bfd97-cc8c-4ca7-9aa9-eca1778dfcea",
"SeriesId": "e8ea8b03-2fcf-47d3-8fa3-20c6c2dc21cc",
"AccessorID": "d0d7c4ff-225d-445a-83cb-faa06bc6a250",
"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": "89870da0-4141-445a-830e-53976e0c13ea",
"ScheduledByID": "5c3b608f-1df4-4d62-8b74-0ca185388cb8",
"DeletedDates": [
"2026-01-29T00:57:39Z",
"2026-01-29T00:57:39Z"
],
"ClearedDates": [
"2026-01-29T00:57:39Z",
"2026-01-29T00:57:39Z"
],
"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-29T00:57:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-29T00:57:39Z",
"CreateDate": "2026-01-29T00:57:39Z",
"OccurTime": "2026-01-29T00:57:39Z",
"OccurEndTime": "2026-01-29T00:57:39Z",
"StartTime": "2026-01-29T00:57:39Z",
"EndTime": "2026-01-29T00:57:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f8ad0230-e9e9-4e6e-9043-7f868ffcf423",
"c5dced63-9339-498e-bb4b-05b096f9580b"
],
"Companies": [
"366acd0a-c6b2-4a56-9a83-82cb32cdbab8",
"00ac97d0-f0fc-40ce-9d97-8c021da42d08"
],
"Groups": [
"d28453ff-35b0-420d-a713-2aa7496a271a",
"5fe83237-5328-47b0-9c25-7d09a62d2148"
],
"Opportunities": [
"d3c941fc-1cc3-47e9-9b9c-21521acbb835",
"a715a29d-7ffc-4201-82d7-56a87b5ebbe7"
]
}
}
]