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": "19579f8d-98b4-4010-9bed-74864ebc6f44",
"SeriesId": "8502c14f-f23e-4722-bd8e-6a385dbf1b12",
"AccessorID": "b3f02a2a-08a4-434d-b2ae-9a9023880b91",
"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": "b3af7e19-0468-4773-91d4-ffe23ca219cc",
"ScheduledByID": "48cfa2a4-27f5-45c4-be7b-9aa91c134bca",
"DeletedDates": [
"2026-06-10T19:33:19Z",
"2026-06-10T19:33:19Z"
],
"ClearedDates": [
"2026-06-10T19:33:19Z",
"2026-06-10T19:33:19Z"
],
"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-10T19:33:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-10T19:33:19Z",
"CreateDate": "2026-06-10T19:33:19Z",
"OccurTime": "2026-06-10T19:33:19Z",
"OccurEndTime": "2026-06-10T19:33:19Z",
"StartTime": "2026-06-10T19:33:19Z",
"EndTime": "2026-06-10T19:33:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3b5d5a1a-3040-4948-838a-e10cd7e112eb",
"5cce4ad4-7128-41d8-8c89-5fbff11f2953"
],
"Companies": [
"761a18dc-aeb2-49b4-bfb1-b219c5705489",
"beddb17d-2229-4414-8454-d184c3a6c176"
],
"Groups": [
"7b3c9297-5888-44e4-85e5-8764b462f049",
"3867169f-c21c-4a39-8cfd-e6deaf6712db"
],
"Opportunities": [
"2bc8f095-b8f4-4879-8ff8-e21ffc7c060a",
"f862aad8-59a0-48cf-bb85-edadf46d4e75"
]
}
},
{
"Id": "19579f8d-98b4-4010-9bed-74864ebc6f44",
"SeriesId": "8502c14f-f23e-4722-bd8e-6a385dbf1b12",
"AccessorID": "b3f02a2a-08a4-434d-b2ae-9a9023880b91",
"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": "b3af7e19-0468-4773-91d4-ffe23ca219cc",
"ScheduledByID": "48cfa2a4-27f5-45c4-be7b-9aa91c134bca",
"DeletedDates": [
"2026-06-10T19:33:19Z",
"2026-06-10T19:33:19Z"
],
"ClearedDates": [
"2026-06-10T19:33:19Z",
"2026-06-10T19:33:19Z"
],
"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-10T19:33:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-10T19:33:19Z",
"CreateDate": "2026-06-10T19:33:19Z",
"OccurTime": "2026-06-10T19:33:19Z",
"OccurEndTime": "2026-06-10T19:33:19Z",
"StartTime": "2026-06-10T19:33:19Z",
"EndTime": "2026-06-10T19:33:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3b5d5a1a-3040-4948-838a-e10cd7e112eb",
"5cce4ad4-7128-41d8-8c89-5fbff11f2953"
],
"Companies": [
"761a18dc-aeb2-49b4-bfb1-b219c5705489",
"beddb17d-2229-4414-8454-d184c3a6c176"
],
"Groups": [
"7b3c9297-5888-44e4-85e5-8764b462f049",
"3867169f-c21c-4a39-8cfd-e6deaf6712db"
],
"Opportunities": [
"2bc8f095-b8f4-4879-8ff8-e21ffc7c060a",
"f862aad8-59a0-48cf-bb85-edadf46d4e75"
]
}
}
]