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": [
"0bb9529a-2f3d-4a04-a18d-391b59376bf6",
"4b9264af-5f90-467a-a978-57cc4c936079"
],
"StartRange": "2025-11-05T00:51:51Z",
"EndRange": "2025-11-05T00:51:51Z",
"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": "2922b8be-30c2-43eb-be23-4ee0e3255f5b",
"SeriesId": "2f487f83-2a4e-4ad9-a279-c8a249fe70c0",
"AccessorID": "96be6738-1a1a-46ff-8fb2-4f63b0fe5459",
"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": "aecf05f6-7b8f-4248-930b-977206c8a5e3",
"ScheduledByID": "ed67a3de-14a0-431f-88e6-10447819c6f4",
"DeletedDates": [
"2025-11-05T00:51:51Z",
"2025-11-05T00:51:51Z"
],
"ClearedDates": [
"2025-11-05T00:51:51Z",
"2025-11-05T00:51:51Z"
],
"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-05T00:51:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-05T00:51:51Z",
"CreateDate": "2025-11-05T00:51:51Z",
"OccurTime": "2025-11-05T00:51:51Z",
"OccurEndTime": "2025-11-05T00:51:51Z",
"StartTime": "2025-11-05T00:51:51Z",
"EndTime": "2025-11-05T00:51:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"402d2992-79f8-425e-86db-9c06d43ff58c",
"4e7d2b9c-9d8b-404a-af3d-80c501724ba8"
],
"Companies": [
"ea77b82c-c30a-435b-b3a5-d6428c08d7d0",
"0876626f-1afd-4b0c-a78a-d09d486da162"
],
"Groups": [
"20496fc6-44a8-48b8-878d-c39e2b48e1b1",
"3ec02917-6254-4b89-ad06-f749be755b81"
],
"Opportunities": [
"7f9dc217-f55e-449f-baf1-002e26a5ec26",
"e2e22970-6988-4f30-aa30-02b448cc8e93"
]
}
},
{
"Id": "2922b8be-30c2-43eb-be23-4ee0e3255f5b",
"SeriesId": "2f487f83-2a4e-4ad9-a279-c8a249fe70c0",
"AccessorID": "96be6738-1a1a-46ff-8fb2-4f63b0fe5459",
"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": "aecf05f6-7b8f-4248-930b-977206c8a5e3",
"ScheduledByID": "ed67a3de-14a0-431f-88e6-10447819c6f4",
"DeletedDates": [
"2025-11-05T00:51:51Z",
"2025-11-05T00:51:51Z"
],
"ClearedDates": [
"2025-11-05T00:51:51Z",
"2025-11-05T00:51:51Z"
],
"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-05T00:51:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-05T00:51:51Z",
"CreateDate": "2025-11-05T00:51:51Z",
"OccurTime": "2025-11-05T00:51:51Z",
"OccurEndTime": "2025-11-05T00:51:51Z",
"StartTime": "2025-11-05T00:51:51Z",
"EndTime": "2025-11-05T00:51:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"402d2992-79f8-425e-86db-9c06d43ff58c",
"4e7d2b9c-9d8b-404a-af3d-80c501724ba8"
],
"Companies": [
"ea77b82c-c30a-435b-b3a5-d6428c08d7d0",
"0876626f-1afd-4b0c-a78a-d09d486da162"
],
"Groups": [
"20496fc6-44a8-48b8-878d-c39e2b48e1b1",
"3ec02917-6254-4b89-ad06-f749be755b81"
],
"Opportunities": [
"7f9dc217-f55e-449f-baf1-002e26a5ec26",
"e2e22970-6988-4f30-aa30-02b448cc8e93"
]
}
}
]