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": "58cb9749-8205-481d-b186-81b1aa4dff9e",
"SeriesId": "f1d0d206-fd12-4997-8d44-6a3289e20eba",
"AccessorID": "dea4dedf-ec88-46c3-a785-2e8666661430",
"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": "57254024-3d10-478f-b4e5-747966f39c4d",
"ScheduledByID": "9df13bb5-11a0-4703-85ae-73102722b2d2",
"DeletedDates": [
"2026-11-01T08:28:01Z",
"2026-11-01T08:28:01Z"
],
"ClearedDates": [
"2026-11-01T08:28:01Z",
"2026-11-01T08:28:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-01T08:28:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-01T08:28:01Z",
"CreateDate": "2026-11-01T08:28:01Z",
"OccurTime": "2026-11-01T08:28:01Z",
"OccurEndTime": "2026-11-01T08:28:01Z",
"StartTime": "2026-11-01T08:28:01Z",
"EndTime": "2026-11-01T08:28:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2559844e-b5a3-41a9-8664-55eed574a130",
"457c295c-4822-456f-8db8-bdb5fa5880ea"
],
"Companies": [
"820d50ce-f9dd-4a05-bda5-a344f3250bcd",
"980c5cad-35db-4642-8130-0b344d8a0306"
],
"Groups": [
"9b94dd80-9485-4fbb-ace9-8454a0cdf601",
"9cdd9dfc-b324-4da0-b55a-bd7873c17d33"
],
"Opportunities": [
"78b08164-fae0-497a-a999-bc3a128648b1",
"64a43527-448e-4be4-97a3-bf5df40984f1"
]
}
},
{
"Id": "58cb9749-8205-481d-b186-81b1aa4dff9e",
"SeriesId": "f1d0d206-fd12-4997-8d44-6a3289e20eba",
"AccessorID": "dea4dedf-ec88-46c3-a785-2e8666661430",
"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": "57254024-3d10-478f-b4e5-747966f39c4d",
"ScheduledByID": "9df13bb5-11a0-4703-85ae-73102722b2d2",
"DeletedDates": [
"2026-11-01T08:28:01Z",
"2026-11-01T08:28:01Z"
],
"ClearedDates": [
"2026-11-01T08:28:01Z",
"2026-11-01T08:28:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-01T08:28:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-01T08:28:01Z",
"CreateDate": "2026-11-01T08:28:01Z",
"OccurTime": "2026-11-01T08:28:01Z",
"OccurEndTime": "2026-11-01T08:28:01Z",
"StartTime": "2026-11-01T08:28:01Z",
"EndTime": "2026-11-01T08:28:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2559844e-b5a3-41a9-8664-55eed574a130",
"457c295c-4822-456f-8db8-bdb5fa5880ea"
],
"Companies": [
"820d50ce-f9dd-4a05-bda5-a344f3250bcd",
"980c5cad-35db-4642-8130-0b344d8a0306"
],
"Groups": [
"9b94dd80-9485-4fbb-ace9-8454a0cdf601",
"9cdd9dfc-b324-4da0-b55a-bd7873c17d33"
],
"Opportunities": [
"78b08164-fae0-497a-a999-bc3a128648b1",
"64a43527-448e-4be4-97a3-bf5df40984f1"
]
}
}
]