GET api/Activities
Get all activities matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeClearedDates, IncludeDeletedDates, DetailFormat
Request Information
URI Parameters
None.
Body Parameters
None.
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": "c811805b-fa13-4d3c-887b-3e035f4566ff",
"SeriesId": "fde7c754-d238-4701-a9e3-2aca44a827d5",
"AccessorID": "f6e9928f-1e7a-4512-95ab-967bc0eb944c",
"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": "22048e9a-040b-4dc2-a24f-c60fc47cf0ec",
"ScheduledByID": "5f16bda8-1575-4f6b-b682-4127bd58b4dd",
"DeletedDates": [
"2026-10-10T06:25:58Z",
"2026-10-10T06:25:58Z"
],
"ClearedDates": [
"2026-10-10T06:25:58Z",
"2026-10-10T06:25:58Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-10T06:25:58Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-10T06:25:58Z",
"CreateDate": "2026-10-10T06:25:58Z",
"OccurTime": "2026-10-10T06:25:58Z",
"OccurEndTime": "2026-10-10T06:25:58Z",
"StartTime": "2026-10-10T06:25:58Z",
"EndTime": "2026-10-10T06:25:58Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0d1bce64-9eaf-4431-ad1d-5d8a994f0c80",
"d47a7320-6cac-4394-a885-95b759cb2de8"
],
"Companies": [
"19dc14b7-b1c0-4ed5-869b-98263c969c01",
"3bafd7e9-a081-4907-9ebc-019d8fa5714f"
],
"Groups": [
"394d2669-a668-448b-a2bf-098ff2906820",
"61fae2da-2c8b-4213-bec9-226f84929d55"
],
"Opportunities": [
"9feb5e55-4a4c-44b2-8547-255cc617921c",
"f9aa07c4-cc6b-4a5f-bb40-9ed14369596b"
]
}
},
{
"Id": "c811805b-fa13-4d3c-887b-3e035f4566ff",
"SeriesId": "fde7c754-d238-4701-a9e3-2aca44a827d5",
"AccessorID": "f6e9928f-1e7a-4512-95ab-967bc0eb944c",
"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": "22048e9a-040b-4dc2-a24f-c60fc47cf0ec",
"ScheduledByID": "5f16bda8-1575-4f6b-b682-4127bd58b4dd",
"DeletedDates": [
"2026-10-10T06:25:58Z",
"2026-10-10T06:25:58Z"
],
"ClearedDates": [
"2026-10-10T06:25:58Z",
"2026-10-10T06:25:58Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-10T06:25:58Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-10T06:25:58Z",
"CreateDate": "2026-10-10T06:25:58Z",
"OccurTime": "2026-10-10T06:25:58Z",
"OccurEndTime": "2026-10-10T06:25:58Z",
"StartTime": "2026-10-10T06:25:58Z",
"EndTime": "2026-10-10T06:25:58Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0d1bce64-9eaf-4431-ad1d-5d8a994f0c80",
"d47a7320-6cac-4394-a885-95b759cb2de8"
],
"Companies": [
"19dc14b7-b1c0-4ed5-869b-98263c969c01",
"3bafd7e9-a081-4907-9ebc-019d8fa5714f"
],
"Groups": [
"394d2669-a668-448b-a2bf-098ff2906820",
"61fae2da-2c8b-4213-bec9-226f84929d55"
],
"Opportunities": [
"9feb5e55-4a4c-44b2-8547-255cc617921c",
"f9aa07c4-cc6b-4a5f-bb40-9ed14369596b"
]
}
}
]