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": "f1cf6a41-5e41-472f-b41e-1607e120f85b",
"SeriesId": "c0590e81-36fa-4657-b1a3-cffe437c0e30",
"AccessorID": "cf448b72-eac1-459d-ab00-a413fa7640df",
"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": "f27f8b72-3f42-444a-801a-8b03523e14a9",
"ScheduledByID": "1a8971e5-1352-4d67-90fe-f18736ad39c8",
"DeletedDates": [
"2026-05-04T10:30:33Z",
"2026-05-04T10:30:33Z"
],
"ClearedDates": [
"2026-05-04T10:30:33Z",
"2026-05-04T10:30:33Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-04T10:30:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T10:30:33Z",
"CreateDate": "2026-05-04T10:30:33Z",
"OccurTime": "2026-05-04T10:30:33Z",
"OccurEndTime": "2026-05-04T10:30:33Z",
"StartTime": "2026-05-04T10:30:33Z",
"EndTime": "2026-05-04T10:30:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aceeb8dd-a8c2-4578-b314-9672a1041e8a",
"18a04605-3d86-4b36-aab8-5114867f40f8"
],
"Companies": [
"71f74422-e6ed-4cca-bf45-1bdaa43a7bbf",
"7865a8fd-0de6-434e-9d2f-7638ba2d067a"
],
"Groups": [
"eec4aece-df6b-403f-aaa5-615bdd343318",
"1f4aed36-ba9d-41e1-ba79-75cad3b30448"
],
"Opportunities": [
"ba36bd52-3b97-4ab8-993e-10365d98342a",
"032118f1-4fa0-484d-a5e6-bfdfd9b0530d"
]
}
},
{
"Id": "f1cf6a41-5e41-472f-b41e-1607e120f85b",
"SeriesId": "c0590e81-36fa-4657-b1a3-cffe437c0e30",
"AccessorID": "cf448b72-eac1-459d-ab00-a413fa7640df",
"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": "f27f8b72-3f42-444a-801a-8b03523e14a9",
"ScheduledByID": "1a8971e5-1352-4d67-90fe-f18736ad39c8",
"DeletedDates": [
"2026-05-04T10:30:33Z",
"2026-05-04T10:30:33Z"
],
"ClearedDates": [
"2026-05-04T10:30:33Z",
"2026-05-04T10:30:33Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-04T10:30:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T10:30:33Z",
"CreateDate": "2026-05-04T10:30:33Z",
"OccurTime": "2026-05-04T10:30:33Z",
"OccurEndTime": "2026-05-04T10:30:33Z",
"StartTime": "2026-05-04T10:30:33Z",
"EndTime": "2026-05-04T10:30:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aceeb8dd-a8c2-4578-b314-9672a1041e8a",
"18a04605-3d86-4b36-aab8-5114867f40f8"
],
"Companies": [
"71f74422-e6ed-4cca-bf45-1bdaa43a7bbf",
"7865a8fd-0de6-434e-9d2f-7638ba2d067a"
],
"Groups": [
"eec4aece-df6b-403f-aaa5-615bdd343318",
"1f4aed36-ba9d-41e1-ba79-75cad3b30448"
],
"Opportunities": [
"ba36bd52-3b97-4ab8-993e-10365d98342a",
"032118f1-4fa0-484d-a5e6-bfdfd9b0530d"
]
}
}
]