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": "3ff6320c-74e1-4155-b8c2-f302f5dbc3ab",
"SeriesId": "ffa7099f-367a-4a3b-8cf0-6acf54c93ae0",
"AccessorID": "9c4fc47e-2616-4511-a8e5-55f0e8a39ff1",
"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": "759174d0-00a1-410b-b785-56b10f524145",
"ScheduledByID": "4380f8d1-523a-4db2-88ea-04e9383de01b",
"DeletedDates": [
"2026-06-20T05:00:42Z",
"2026-06-20T05:00:42Z"
],
"ClearedDates": [
"2026-06-20T05:00:42Z",
"2026-06-20T05:00:42Z"
],
"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-20T05:00:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-20T05:00:42Z",
"CreateDate": "2026-06-20T05:00:42Z",
"OccurTime": "2026-06-20T05:00:42Z",
"OccurEndTime": "2026-06-20T05:00:42Z",
"StartTime": "2026-06-20T05:00:42Z",
"EndTime": "2026-06-20T05:00:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"52607329-63af-466d-a00b-4f51339fbac3",
"19c8c290-9459-41ae-a9e0-90eb5803e210"
],
"Companies": [
"ef10d468-0d40-46be-bd0f-2a40269c541d",
"c52d4525-0d53-4f3d-8fec-543b0af0a54e"
],
"Groups": [
"a3811036-aa28-402a-847a-286bf5083de6",
"48cdb5b8-e324-4cd0-b330-97b510296b82"
],
"Opportunities": [
"4e6b0dad-f97d-4101-96a4-b6f243738ca0",
"490af3bb-3ad0-4eac-ad14-cd102ab7adc8"
]
}
},
{
"Id": "3ff6320c-74e1-4155-b8c2-f302f5dbc3ab",
"SeriesId": "ffa7099f-367a-4a3b-8cf0-6acf54c93ae0",
"AccessorID": "9c4fc47e-2616-4511-a8e5-55f0e8a39ff1",
"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": "759174d0-00a1-410b-b785-56b10f524145",
"ScheduledByID": "4380f8d1-523a-4db2-88ea-04e9383de01b",
"DeletedDates": [
"2026-06-20T05:00:42Z",
"2026-06-20T05:00:42Z"
],
"ClearedDates": [
"2026-06-20T05:00:42Z",
"2026-06-20T05:00:42Z"
],
"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-20T05:00:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-20T05:00:42Z",
"CreateDate": "2026-06-20T05:00:42Z",
"OccurTime": "2026-06-20T05:00:42Z",
"OccurEndTime": "2026-06-20T05:00:42Z",
"StartTime": "2026-06-20T05:00:42Z",
"EndTime": "2026-06-20T05:00:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"52607329-63af-466d-a00b-4f51339fbac3",
"19c8c290-9459-41ae-a9e0-90eb5803e210"
],
"Companies": [
"ef10d468-0d40-46be-bd0f-2a40269c541d",
"c52d4525-0d53-4f3d-8fec-543b0af0a54e"
],
"Groups": [
"a3811036-aa28-402a-847a-286bf5083de6",
"48cdb5b8-e324-4cd0-b330-97b510296b82"
],
"Opportunities": [
"4e6b0dad-f97d-4101-96a4-b6f243738ca0",
"490af3bb-3ad0-4eac-ad14-cd102ab7adc8"
]
}
}
]