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": [
"48966a4d-b981-4267-9d84-d8951d275fa6",
"fc887249-3a30-4896-8aae-377a68dc9411"
],
"StartRange": "2026-04-19T12:08:22Z",
"EndRange": "2026-04-19T12:08:22Z",
"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": "43c00635-45ba-4d88-8ca1-ee97ae75d1b6",
"SeriesId": "433412d9-6e26-4330-a1bb-6b21278edfbe",
"AccessorID": "172f2d4a-4958-4bf9-9c8d-8b053aab63a6",
"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": "5deef8a2-443b-40e4-9a9b-09122c164d22",
"ScheduledByID": "9468d9d0-1d89-4852-8077-2c4aa4b803e8",
"DeletedDates": [
"2026-04-19T12:08:22Z",
"2026-04-19T12:08:22Z"
],
"ClearedDates": [
"2026-04-19T12:08:22Z",
"2026-04-19T12:08:22Z"
],
"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-19T12:08:22Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-19T12:08:22Z",
"CreateDate": "2026-04-19T12:08:22Z",
"OccurTime": "2026-04-19T12:08:22Z",
"OccurEndTime": "2026-04-19T12:08:22Z",
"StartTime": "2026-04-19T12:08:22Z",
"EndTime": "2026-04-19T12:08:22Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"396d04e1-01c6-4564-b167-ff7924803f29",
"95fd90f3-d2e8-47d5-ad47-0ff308cd8940"
],
"Companies": [
"eec650ed-ba50-4522-b438-09551d7a9b47",
"9767b9a2-10ef-4bef-af3c-5cfd46696233"
],
"Groups": [
"b6123eea-9485-4e59-b38b-3c0fdc90572f",
"ae47b84d-527e-420e-9f00-b144fbc72eb2"
],
"Opportunities": [
"0ed89ba4-5efc-49ef-a72c-ad14957004d7",
"80d6dbc0-5afe-4cee-be62-d63f397be91f"
]
}
},
{
"Id": "43c00635-45ba-4d88-8ca1-ee97ae75d1b6",
"SeriesId": "433412d9-6e26-4330-a1bb-6b21278edfbe",
"AccessorID": "172f2d4a-4958-4bf9-9c8d-8b053aab63a6",
"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": "5deef8a2-443b-40e4-9a9b-09122c164d22",
"ScheduledByID": "9468d9d0-1d89-4852-8077-2c4aa4b803e8",
"DeletedDates": [
"2026-04-19T12:08:22Z",
"2026-04-19T12:08:22Z"
],
"ClearedDates": [
"2026-04-19T12:08:22Z",
"2026-04-19T12:08:22Z"
],
"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-19T12:08:22Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-19T12:08:22Z",
"CreateDate": "2026-04-19T12:08:22Z",
"OccurTime": "2026-04-19T12:08:22Z",
"OccurEndTime": "2026-04-19T12:08:22Z",
"StartTime": "2026-04-19T12:08:22Z",
"EndTime": "2026-04-19T12:08:22Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"396d04e1-01c6-4564-b167-ff7924803f29",
"95fd90f3-d2e8-47d5-ad47-0ff308cd8940"
],
"Companies": [
"eec650ed-ba50-4522-b438-09551d7a9b47",
"9767b9a2-10ef-4bef-af3c-5cfd46696233"
],
"Groups": [
"b6123eea-9485-4e59-b38b-3c0fdc90572f",
"ae47b84d-527e-420e-9f00-b144fbc72eb2"
],
"Opportunities": [
"0ed89ba4-5efc-49ef-a72c-ad14957004d7",
"80d6dbc0-5afe-4cee-be62-d63f397be91f"
]
}
}
]