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": [
"0912beb0-5f08-4c35-9c08-27f384f4aaf4",
"078854f1-7641-4aaa-b9c8-eb1afeb8aa03"
],
"StartRange": "2025-11-30T11:44:29Z",
"EndRange": "2025-11-30T11:44:29Z",
"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": "f4de4d0b-001c-4901-9598-86b94a901bb1",
"SeriesId": "626be53e-cd5a-482d-9cc9-f4f7da888485",
"AccessorID": "e416e45a-07d8-4004-9d9a-432a4c21bef7",
"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": "85e448f7-d235-49e6-8353-3ad0f8308c07",
"ScheduledByID": "dd131682-93db-4cee-898a-8e9b048274f5",
"DeletedDates": [
"2025-11-30T11:44:29Z",
"2025-11-30T11:44:29Z"
],
"ClearedDates": [
"2025-11-30T11:44:29Z",
"2025-11-30T11:44:29Z"
],
"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-30T11:44:29Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-30T11:44:29Z",
"CreateDate": "2025-11-30T11:44:29Z",
"OccurTime": "2025-11-30T11:44:29Z",
"OccurEndTime": "2025-11-30T11:44:29Z",
"StartTime": "2025-11-30T11:44:29Z",
"EndTime": "2025-11-30T11:44:29Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18a22440-f8f0-4a8e-bccc-49c0ba102119",
"7be21c0d-d8f2-4fa0-b293-f743b4f9f673"
],
"Companies": [
"f668fce6-84a9-465c-bee9-352fd2734b33",
"53fa2aeb-ddd8-4675-9d75-ce037c9433aa"
],
"Groups": [
"2f74152f-493d-446b-b873-00a47b0d18e2",
"f0b5e323-cdd5-4b3f-b717-9ed4df2b4925"
],
"Opportunities": [
"ffd3091b-79e2-42f5-b983-0b1ccab2773f",
"ebfd3558-9f9d-461a-95bd-1b3c69b9b6a1"
]
}
},
{
"Id": "f4de4d0b-001c-4901-9598-86b94a901bb1",
"SeriesId": "626be53e-cd5a-482d-9cc9-f4f7da888485",
"AccessorID": "e416e45a-07d8-4004-9d9a-432a4c21bef7",
"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": "85e448f7-d235-49e6-8353-3ad0f8308c07",
"ScheduledByID": "dd131682-93db-4cee-898a-8e9b048274f5",
"DeletedDates": [
"2025-11-30T11:44:29Z",
"2025-11-30T11:44:29Z"
],
"ClearedDates": [
"2025-11-30T11:44:29Z",
"2025-11-30T11:44:29Z"
],
"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-30T11:44:29Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-30T11:44:29Z",
"CreateDate": "2025-11-30T11:44:29Z",
"OccurTime": "2025-11-30T11:44:29Z",
"OccurEndTime": "2025-11-30T11:44:29Z",
"StartTime": "2025-11-30T11:44:29Z",
"EndTime": "2025-11-30T11:44:29Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18a22440-f8f0-4a8e-bccc-49c0ba102119",
"7be21c0d-d8f2-4fa0-b293-f743b4f9f673"
],
"Companies": [
"f668fce6-84a9-465c-bee9-352fd2734b33",
"53fa2aeb-ddd8-4675-9d75-ce037c9433aa"
],
"Groups": [
"2f74152f-493d-446b-b873-00a47b0d18e2",
"f0b5e323-cdd5-4b3f-b717-9ed4df2b4925"
],
"Opportunities": [
"ffd3091b-79e2-42f5-b983-0b1ccab2773f",
"ebfd3558-9f9d-461a-95bd-1b3c69b9b6a1"
]
}
}
]