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": "82b93b22-cc9b-47a3-a704-4d2acf4a17fe",
"SeriesId": "0972ce77-dbf5-4b01-ba4f-b1687e5081c7",
"AccessorID": "dd95d168-e2e1-4b95-b25e-ddf2adae5ef1",
"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": "9f58f140-b8fe-482f-b294-102f074617e0",
"ScheduledByID": "d9732360-3dcd-42b3-8a65-6403367abd49",
"DeletedDates": [
"2026-08-12T04:08:07Z",
"2026-08-12T04:08:07Z"
],
"ClearedDates": [
"2026-08-12T04:08:07Z",
"2026-08-12T04:08:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-12T04:08:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-12T04:08:07Z",
"CreateDate": "2026-08-12T04:08:07Z",
"OccurTime": "2026-08-12T04:08:07Z",
"OccurEndTime": "2026-08-12T04:08:07Z",
"StartTime": "2026-08-12T04:08:07Z",
"EndTime": "2026-08-12T04:08:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"eeedacaa-7330-481b-9024-cfa3b7659351",
"b640c975-cb02-4690-a535-3fc3123589b6"
],
"Companies": [
"ca9213c5-da69-4515-84cd-975f1635fc16",
"c6bd15b6-b4bb-4f6f-9878-ca737a8a2b9a"
],
"Groups": [
"8d2a5523-e1ac-4889-a783-bd7af97538fb",
"1b60aaed-22d0-4ecd-923e-a76886613baf"
],
"Opportunities": [
"79cbecd7-325c-4193-ad89-cf3c8aedf252",
"804a90a4-b927-4737-9e6b-3687af4c7d84"
]
}
},
{
"Id": "82b93b22-cc9b-47a3-a704-4d2acf4a17fe",
"SeriesId": "0972ce77-dbf5-4b01-ba4f-b1687e5081c7",
"AccessorID": "dd95d168-e2e1-4b95-b25e-ddf2adae5ef1",
"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": "9f58f140-b8fe-482f-b294-102f074617e0",
"ScheduledByID": "d9732360-3dcd-42b3-8a65-6403367abd49",
"DeletedDates": [
"2026-08-12T04:08:07Z",
"2026-08-12T04:08:07Z"
],
"ClearedDates": [
"2026-08-12T04:08:07Z",
"2026-08-12T04:08:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-12T04:08:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-12T04:08:07Z",
"CreateDate": "2026-08-12T04:08:07Z",
"OccurTime": "2026-08-12T04:08:07Z",
"OccurEndTime": "2026-08-12T04:08:07Z",
"StartTime": "2026-08-12T04:08:07Z",
"EndTime": "2026-08-12T04:08:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"eeedacaa-7330-481b-9024-cfa3b7659351",
"b640c975-cb02-4690-a535-3fc3123589b6"
],
"Companies": [
"ca9213c5-da69-4515-84cd-975f1635fc16",
"c6bd15b6-b4bb-4f6f-9878-ca737a8a2b9a"
],
"Groups": [
"8d2a5523-e1ac-4889-a783-bd7af97538fb",
"1b60aaed-22d0-4ecd-923e-a76886613baf"
],
"Opportunities": [
"79cbecd7-325c-4193-ad89-cf3c8aedf252",
"804a90a4-b927-4737-9e6b-3687af4c7d84"
]
}
}
]