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": "ed71e9b3-f236-4fa1-a50f-10cc1f6e9130",
"SeriesId": "46cd72c1-6d0b-4570-a459-331abedf8aa3",
"AccessorID": "e2639b13-d88a-4090-8f87-bfdbade88f1f",
"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": "1548d5e9-be08-4ce8-8938-d41ca6367a51",
"ScheduledByID": "ab180323-fa62-41f5-a58a-1a55894379b5",
"DeletedDates": [
"2026-06-19T05:17:30Z",
"2026-06-19T05:17:30Z"
],
"ClearedDates": [
"2026-06-19T05:17:30Z",
"2026-06-19T05:17:30Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-19T05:17:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-19T05:17:30Z",
"CreateDate": "2026-06-19T05:17:30Z",
"OccurTime": "2026-06-19T05:17:30Z",
"OccurEndTime": "2026-06-19T05:17:30Z",
"StartTime": "2026-06-19T05:17:30Z",
"EndTime": "2026-06-19T05:17:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"17765baf-2d0b-4fb3-b456-8e882229f9b2",
"e97121e0-2a2a-43c2-b69e-9b719ca8f105"
],
"Companies": [
"357477ff-c7ff-40fe-9df0-35295bc01e8e",
"60541cfa-8634-4a33-a5ca-5d474eb17f34"
],
"Groups": [
"3cc3ba83-7530-436a-8c17-c7af0a746b44",
"781e7ff4-43e5-44bf-91d4-635219c51138"
],
"Opportunities": [
"c89d9e96-0fdc-4169-b279-6053ca12ef0d",
"0a4663f7-f2d8-4819-9568-946807a87dbe"
]
}
},
{
"Id": "ed71e9b3-f236-4fa1-a50f-10cc1f6e9130",
"SeriesId": "46cd72c1-6d0b-4570-a459-331abedf8aa3",
"AccessorID": "e2639b13-d88a-4090-8f87-bfdbade88f1f",
"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": "1548d5e9-be08-4ce8-8938-d41ca6367a51",
"ScheduledByID": "ab180323-fa62-41f5-a58a-1a55894379b5",
"DeletedDates": [
"2026-06-19T05:17:30Z",
"2026-06-19T05:17:30Z"
],
"ClearedDates": [
"2026-06-19T05:17:30Z",
"2026-06-19T05:17:30Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-19T05:17:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-19T05:17:30Z",
"CreateDate": "2026-06-19T05:17:30Z",
"OccurTime": "2026-06-19T05:17:30Z",
"OccurEndTime": "2026-06-19T05:17:30Z",
"StartTime": "2026-06-19T05:17:30Z",
"EndTime": "2026-06-19T05:17:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"17765baf-2d0b-4fb3-b456-8e882229f9b2",
"e97121e0-2a2a-43c2-b69e-9b719ca8f105"
],
"Companies": [
"357477ff-c7ff-40fe-9df0-35295bc01e8e",
"60541cfa-8634-4a33-a5ca-5d474eb17f34"
],
"Groups": [
"3cc3ba83-7530-436a-8c17-c7af0a746b44",
"781e7ff4-43e5-44bf-91d4-635219c51138"
],
"Opportunities": [
"c89d9e96-0fdc-4169-b279-6053ca12ef0d",
"0a4663f7-f2d8-4819-9568-946807a87dbe"
]
}
}
]