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": "a42fe5f3-4a65-49f8-a2f8-5caff32d9aea",
"SeriesId": "ff869fff-666b-4b9c-9d44-d178f0ea83d3",
"AccessorID": "3740b300-eea8-4807-9b66-f53e7ac6356b",
"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": "21374330-1974-4fae-8f87-52a6d52ee60b",
"ScheduledByID": "a65a7a95-762b-4c0b-b8fd-a10eeeca6fb3",
"DeletedDates": [
"2026-04-05T08:56:14Z",
"2026-04-05T08:56:14Z"
],
"ClearedDates": [
"2026-04-05T08:56:14Z",
"2026-04-05T08:56:14Z"
],
"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-05T08:56:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-05T08:56:14Z",
"CreateDate": "2026-04-05T08:56:14Z",
"OccurTime": "2026-04-05T08:56:14Z",
"OccurEndTime": "2026-04-05T08:56:14Z",
"StartTime": "2026-04-05T08:56:14Z",
"EndTime": "2026-04-05T08:56:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6fda0606-bb07-4985-9427-42a31b3361ff",
"a543d065-9704-46b5-8139-629f3693c040"
],
"Companies": [
"4f571570-ab0f-4491-9485-05a046d6edb2",
"49cdc632-58a3-49dc-813b-5b4813b0fef7"
],
"Groups": [
"7989a985-e734-4d6c-9c28-88f1ad75704a",
"378679da-1176-4f89-ac94-0760366d6fb9"
],
"Opportunities": [
"0daf94ba-5a9a-4e8f-ab29-f61db111ea74",
"cbae3ec7-5df1-4349-9085-074ca490c877"
]
}
},
{
"Id": "a42fe5f3-4a65-49f8-a2f8-5caff32d9aea",
"SeriesId": "ff869fff-666b-4b9c-9d44-d178f0ea83d3",
"AccessorID": "3740b300-eea8-4807-9b66-f53e7ac6356b",
"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": "21374330-1974-4fae-8f87-52a6d52ee60b",
"ScheduledByID": "a65a7a95-762b-4c0b-b8fd-a10eeeca6fb3",
"DeletedDates": [
"2026-04-05T08:56:14Z",
"2026-04-05T08:56:14Z"
],
"ClearedDates": [
"2026-04-05T08:56:14Z",
"2026-04-05T08:56:14Z"
],
"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-05T08:56:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-05T08:56:14Z",
"CreateDate": "2026-04-05T08:56:14Z",
"OccurTime": "2026-04-05T08:56:14Z",
"OccurEndTime": "2026-04-05T08:56:14Z",
"StartTime": "2026-04-05T08:56:14Z",
"EndTime": "2026-04-05T08:56:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6fda0606-bb07-4985-9427-42a31b3361ff",
"a543d065-9704-46b5-8139-629f3693c040"
],
"Companies": [
"4f571570-ab0f-4491-9485-05a046d6edb2",
"49cdc632-58a3-49dc-813b-5b4813b0fef7"
],
"Groups": [
"7989a985-e734-4d6c-9c28-88f1ad75704a",
"378679da-1176-4f89-ac94-0760366d6fb9"
],
"Opportunities": [
"0daf94ba-5a9a-4e8f-ab29-f61db111ea74",
"cbae3ec7-5df1-4349-9085-074ca490c877"
]
}
}
]