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": [
"5cff565f-d827-49bb-9f1e-0d4413544de7",
"2d24b738-4213-42fd-b8b2-418590720b84"
],
"StartRange": "2025-11-29T22:17:59Z",
"EndRange": "2025-11-29T22:17:59Z",
"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": "2dbb7ca8-6868-4035-96e1-862d0583c896",
"SeriesId": "197ef96e-bced-4b36-b559-f9f8372b6276",
"AccessorID": "975352b6-5732-4d29-9a04-f6bde9aa52ea",
"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": "37794f04-5112-4007-8386-0e9dd872147c",
"ScheduledByID": "5d6e7e63-9399-433c-9ec4-fe5d7c08186c",
"DeletedDates": [
"2025-11-29T22:17:59Z",
"2025-11-29T22:17:59Z"
],
"ClearedDates": [
"2025-11-29T22:17:59Z",
"2025-11-29T22:17:59Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-29T22:17:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-29T22:17:59Z",
"CreateDate": "2025-11-29T22:17:59Z",
"OccurTime": "2025-11-29T22:17:59Z",
"OccurEndTime": "2025-11-29T22:17:59Z",
"StartTime": "2025-11-29T22:17:59Z",
"EndTime": "2025-11-29T22:17:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1ca61410-6c8c-4d9f-9eff-2f6630263ffc",
"12e178e0-c64f-4294-bfa8-27a5e2b006d7"
],
"Companies": [
"18b5282e-ee1f-4947-8c00-d4e5d13afc14",
"95c34021-e902-4c24-8049-5d923285a937"
],
"Groups": [
"5a6e19a0-6fcc-48b6-b410-e30ebe1bab7f",
"c5413f33-b32c-4e4b-a15c-9c2c200dd9cd"
],
"Opportunities": [
"4b6dcd49-9f67-451d-a3a5-aa6b9e96691d",
"9c981b3a-9ee6-4fab-9f4d-bdd97ba0a2f1"
]
}
},
{
"Id": "2dbb7ca8-6868-4035-96e1-862d0583c896",
"SeriesId": "197ef96e-bced-4b36-b559-f9f8372b6276",
"AccessorID": "975352b6-5732-4d29-9a04-f6bde9aa52ea",
"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": "37794f04-5112-4007-8386-0e9dd872147c",
"ScheduledByID": "5d6e7e63-9399-433c-9ec4-fe5d7c08186c",
"DeletedDates": [
"2025-11-29T22:17:59Z",
"2025-11-29T22:17:59Z"
],
"ClearedDates": [
"2025-11-29T22:17:59Z",
"2025-11-29T22:17:59Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-29T22:17:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-29T22:17:59Z",
"CreateDate": "2025-11-29T22:17:59Z",
"OccurTime": "2025-11-29T22:17:59Z",
"OccurEndTime": "2025-11-29T22:17:59Z",
"StartTime": "2025-11-29T22:17:59Z",
"EndTime": "2025-11-29T22:17:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1ca61410-6c8c-4d9f-9eff-2f6630263ffc",
"12e178e0-c64f-4294-bfa8-27a5e2b006d7"
],
"Companies": [
"18b5282e-ee1f-4947-8c00-d4e5d13afc14",
"95c34021-e902-4c24-8049-5d923285a937"
],
"Groups": [
"5a6e19a0-6fcc-48b6-b410-e30ebe1bab7f",
"c5413f33-b32c-4e4b-a15c-9c2c200dd9cd"
],
"Opportunities": [
"4b6dcd49-9f67-451d-a3a5-aa6b9e96691d",
"9c981b3a-9ee6-4fab-9f4d-bdd97ba0a2f1"
]
}
}
]