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": [
"e34155c0-0799-4f4f-b951-a508611c1284",
"64c0a811-6730-4564-95c8-322ca110438a"
],
"StartRange": "2026-01-21T21:30:06Z",
"EndRange": "2026-01-21T21:30:06Z",
"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": "843291fe-2ce2-4e7c-81ab-c0430beacd5d",
"SeriesId": "44a2da78-8a83-4cf8-9359-ab09021d949b",
"AccessorID": "5874d1a9-8de1-4bff-a282-2e0c818f9cbe",
"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": "5a61627c-07d6-4252-b7d0-9825ca1550e9",
"ScheduledByID": "4f5d6391-8fd3-4cc6-878e-92acad4b4c2b",
"DeletedDates": [
"2026-01-21T21:30:06Z",
"2026-01-21T21:30:06Z"
],
"ClearedDates": [
"2026-01-21T21:30:06Z",
"2026-01-21T21:30:06Z"
],
"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-21T21:30:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-21T21:30:06Z",
"CreateDate": "2026-01-21T21:30:06Z",
"OccurTime": "2026-01-21T21:30:06Z",
"OccurEndTime": "2026-01-21T21:30:06Z",
"StartTime": "2026-01-21T21:30:06Z",
"EndTime": "2026-01-21T21:30:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"21c48bd0-d317-479d-9bcb-1eae49691782",
"297237f4-a44a-47bb-bcda-839c23540e7f"
],
"Companies": [
"6694aa08-08ff-4265-9b20-4f0fe688c9ed",
"20980d40-cd57-4b46-9980-9e72b5518db3"
],
"Groups": [
"2b3d2298-8156-4024-9512-cf1d4f7f56ff",
"48147523-30dd-4ff1-a3c1-37c6f38a6744"
],
"Opportunities": [
"4f47c04e-04b4-4a77-a902-f5c278f927fc",
"bf4fe31e-4e74-44d8-a879-5b736768050f"
]
}
},
{
"Id": "843291fe-2ce2-4e7c-81ab-c0430beacd5d",
"SeriesId": "44a2da78-8a83-4cf8-9359-ab09021d949b",
"AccessorID": "5874d1a9-8de1-4bff-a282-2e0c818f9cbe",
"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": "5a61627c-07d6-4252-b7d0-9825ca1550e9",
"ScheduledByID": "4f5d6391-8fd3-4cc6-878e-92acad4b4c2b",
"DeletedDates": [
"2026-01-21T21:30:06Z",
"2026-01-21T21:30:06Z"
],
"ClearedDates": [
"2026-01-21T21:30:06Z",
"2026-01-21T21:30:06Z"
],
"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-21T21:30:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-21T21:30:06Z",
"CreateDate": "2026-01-21T21:30:06Z",
"OccurTime": "2026-01-21T21:30:06Z",
"OccurEndTime": "2026-01-21T21:30:06Z",
"StartTime": "2026-01-21T21:30:06Z",
"EndTime": "2026-01-21T21:30:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"21c48bd0-d317-479d-9bcb-1eae49691782",
"297237f4-a44a-47bb-bcda-839c23540e7f"
],
"Companies": [
"6694aa08-08ff-4265-9b20-4f0fe688c9ed",
"20980d40-cd57-4b46-9980-9e72b5518db3"
],
"Groups": [
"2b3d2298-8156-4024-9512-cf1d4f7f56ff",
"48147523-30dd-4ff1-a3c1-37c6f38a6744"
],
"Opportunities": [
"4f47c04e-04b4-4a77-a902-f5c278f927fc",
"bf4fe31e-4e74-44d8-a879-5b736768050f"
]
}
}
]