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": [
"ed2c488e-ff20-4844-98ed-e5588036c23d",
"8ef4d011-be52-47d5-84f4-c353fc91bc11"
],
"StartRange": "2026-04-15T00:16:31Z",
"EndRange": "2026-04-15T00:16:31Z",
"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": "51fa23de-4abd-4b3d-9486-4654fe530eb4",
"SeriesId": "c28731aa-ecea-4519-8cca-36d1a3223f78",
"AccessorID": "76710989-0670-4160-a030-b28bd9d4b632",
"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": "7f136ba7-bd24-4ee9-b905-e0b2128dfe78",
"ScheduledByID": "57c0ac51-3b45-481e-a452-b705adf13127",
"DeletedDates": [
"2026-04-15T00:16:31Z",
"2026-04-15T00:16:31Z"
],
"ClearedDates": [
"2026-04-15T00:16:31Z",
"2026-04-15T00:16:31Z"
],
"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-15T00:16:31Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-15T00:16:31Z",
"CreateDate": "2026-04-15T00:16:31Z",
"OccurTime": "2026-04-15T00:16:31Z",
"OccurEndTime": "2026-04-15T00:16:31Z",
"StartTime": "2026-04-15T00:16:31Z",
"EndTime": "2026-04-15T00:16:31Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d7609aef-0cee-4e4e-8a7a-51d97745d1c2",
"3cf17233-773e-4c14-9ca1-2991af864e53"
],
"Companies": [
"1319bada-7d67-4531-83e6-748a619b45de",
"680949fb-97de-4344-a206-6aae58af9ff1"
],
"Groups": [
"a0eb39a4-d9d5-4926-a8ea-b5a92f2e490d",
"a4b0dec1-d24e-41d0-92db-65a0064561c0"
],
"Opportunities": [
"0b666ea2-c350-4fc3-b167-21641d7d7b35",
"aa66c678-4cd7-4488-980e-920e7b09d643"
]
}
},
{
"Id": "51fa23de-4abd-4b3d-9486-4654fe530eb4",
"SeriesId": "c28731aa-ecea-4519-8cca-36d1a3223f78",
"AccessorID": "76710989-0670-4160-a030-b28bd9d4b632",
"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": "7f136ba7-bd24-4ee9-b905-e0b2128dfe78",
"ScheduledByID": "57c0ac51-3b45-481e-a452-b705adf13127",
"DeletedDates": [
"2026-04-15T00:16:31Z",
"2026-04-15T00:16:31Z"
],
"ClearedDates": [
"2026-04-15T00:16:31Z",
"2026-04-15T00:16:31Z"
],
"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-15T00:16:31Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-15T00:16:31Z",
"CreateDate": "2026-04-15T00:16:31Z",
"OccurTime": "2026-04-15T00:16:31Z",
"OccurEndTime": "2026-04-15T00:16:31Z",
"StartTime": "2026-04-15T00:16:31Z",
"EndTime": "2026-04-15T00:16:31Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d7609aef-0cee-4e4e-8a7a-51d97745d1c2",
"3cf17233-773e-4c14-9ca1-2991af864e53"
],
"Companies": [
"1319bada-7d67-4531-83e6-748a619b45de",
"680949fb-97de-4344-a206-6aae58af9ff1"
],
"Groups": [
"a0eb39a4-d9d5-4926-a8ea-b5a92f2e490d",
"a4b0dec1-d24e-41d0-92db-65a0064561c0"
],
"Opportunities": [
"0b666ea2-c350-4fc3-b167-21641d7d7b35",
"aa66c678-4cd7-4488-980e-920e7b09d643"
]
}
}
]