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": [
"cb794141-c96c-4de8-ab99-ad60bea89bab",
"eff88603-be7c-4dcc-ac2b-d20bc7a7183e"
],
"StartRange": "2025-12-17T01:06:45Z",
"EndRange": "2025-12-17T01:06:45Z",
"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": "4d080b47-659b-4f40-ba36-3ffea0364ed6",
"SeriesId": "eca2644b-dcb1-4035-8547-b7e62e53f498",
"AccessorID": "6d1375de-55c7-4825-9fdb-34b7cd2cf5ae",
"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": "47b73278-be2e-4058-aa30-c4fce5a114a6",
"ScheduledByID": "d2194165-30e9-4725-a6ed-5e7eb39de92d",
"DeletedDates": [
"2025-12-17T01:06:45Z",
"2025-12-17T01:06:45Z"
],
"ClearedDates": [
"2025-12-17T01:06:45Z",
"2025-12-17T01:06:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-17T01:06:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-17T01:06:45Z",
"CreateDate": "2025-12-17T01:06:45Z",
"OccurTime": "2025-12-17T01:06:45Z",
"OccurEndTime": "2025-12-17T01:06:45Z",
"StartTime": "2025-12-17T01:06:45Z",
"EndTime": "2025-12-17T01:06:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"411835b3-5a02-4d08-937e-f6f956eeacaf",
"1e2721ca-8d5f-4b2f-950f-a7d608ae5d4e"
],
"Companies": [
"b885bb2d-508f-4187-a3fe-b903921e7fd0",
"296e8e7a-28cf-411e-9ff7-e8dc3f8b2ea7"
],
"Groups": [
"11263abf-5aa3-4ee9-bfc6-e543eb91a73f",
"fd1f5519-6e8b-444f-bb97-d3a106b01f20"
],
"Opportunities": [
"fa5564e7-57f9-40a4-a8e5-ae67b66eec6e",
"4af94f0d-1c21-440d-a545-fb6ac34a799f"
]
}
},
{
"Id": "4d080b47-659b-4f40-ba36-3ffea0364ed6",
"SeriesId": "eca2644b-dcb1-4035-8547-b7e62e53f498",
"AccessorID": "6d1375de-55c7-4825-9fdb-34b7cd2cf5ae",
"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": "47b73278-be2e-4058-aa30-c4fce5a114a6",
"ScheduledByID": "d2194165-30e9-4725-a6ed-5e7eb39de92d",
"DeletedDates": [
"2025-12-17T01:06:45Z",
"2025-12-17T01:06:45Z"
],
"ClearedDates": [
"2025-12-17T01:06:45Z",
"2025-12-17T01:06:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-17T01:06:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-17T01:06:45Z",
"CreateDate": "2025-12-17T01:06:45Z",
"OccurTime": "2025-12-17T01:06:45Z",
"OccurEndTime": "2025-12-17T01:06:45Z",
"StartTime": "2025-12-17T01:06:45Z",
"EndTime": "2025-12-17T01:06:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"411835b3-5a02-4d08-937e-f6f956eeacaf",
"1e2721ca-8d5f-4b2f-950f-a7d608ae5d4e"
],
"Companies": [
"b885bb2d-508f-4187-a3fe-b903921e7fd0",
"296e8e7a-28cf-411e-9ff7-e8dc3f8b2ea7"
],
"Groups": [
"11263abf-5aa3-4ee9-bfc6-e543eb91a73f",
"fd1f5519-6e8b-444f-bb97-d3a106b01f20"
],
"Opportunities": [
"fa5564e7-57f9-40a4-a8e5-ae67b66eec6e",
"4af94f0d-1c21-440d-a545-fb6ac34a799f"
]
}
}
]