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": "1447c83a-6bfc-4545-a1f2-216e29887da8",
"SeriesId": "ed8457d8-a384-4c13-9051-5c847772d1f2",
"AccessorID": "e3990099-331b-46f7-93a9-ab39a53826aa",
"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": "45765fce-f550-4d01-a028-f900330d53da",
"ScheduledByID": "71d47486-0b66-4a58-b2f7-921088f8e5ce",
"DeletedDates": [
"2026-11-20T20:47:54Z",
"2026-11-20T20:47:54Z"
],
"ClearedDates": [
"2026-11-20T20:47:54Z",
"2026-11-20T20:47:54Z"
],
"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-20T20:47:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-20T20:47:54Z",
"CreateDate": "2026-11-20T20:47:54Z",
"OccurTime": "2026-11-20T20:47:54Z",
"OccurEndTime": "2026-11-20T20:47:54Z",
"StartTime": "2026-11-20T20:47:54Z",
"EndTime": "2026-11-20T20:47:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"96270d28-e5f0-4b4b-8dbf-67108e685479",
"1dc76d28-ec73-41f0-ab7e-e436c26dd6db"
],
"Companies": [
"dd277fcd-906e-4fcb-a285-50a7c731fb74",
"8a16f320-27f4-4a53-98a9-7166825ba039"
],
"Groups": [
"b17b10b7-af33-4daa-82c9-5e424cbc045d",
"ef339270-0c90-4019-8b60-b2ed09c624f3"
],
"Opportunities": [
"790d4c92-d0d2-4229-8f6c-48b881b537c4",
"87097b19-d236-409e-a1fc-78a76cd6dcf2"
]
}
},
{
"Id": "1447c83a-6bfc-4545-a1f2-216e29887da8",
"SeriesId": "ed8457d8-a384-4c13-9051-5c847772d1f2",
"AccessorID": "e3990099-331b-46f7-93a9-ab39a53826aa",
"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": "45765fce-f550-4d01-a028-f900330d53da",
"ScheduledByID": "71d47486-0b66-4a58-b2f7-921088f8e5ce",
"DeletedDates": [
"2026-11-20T20:47:54Z",
"2026-11-20T20:47:54Z"
],
"ClearedDates": [
"2026-11-20T20:47:54Z",
"2026-11-20T20:47:54Z"
],
"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-20T20:47:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-20T20:47:54Z",
"CreateDate": "2026-11-20T20:47:54Z",
"OccurTime": "2026-11-20T20:47:54Z",
"OccurEndTime": "2026-11-20T20:47:54Z",
"StartTime": "2026-11-20T20:47:54Z",
"EndTime": "2026-11-20T20:47:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"96270d28-e5f0-4b4b-8dbf-67108e685479",
"1dc76d28-ec73-41f0-ab7e-e436c26dd6db"
],
"Companies": [
"dd277fcd-906e-4fcb-a285-50a7c731fb74",
"8a16f320-27f4-4a53-98a9-7166825ba039"
],
"Groups": [
"b17b10b7-af33-4daa-82c9-5e424cbc045d",
"ef339270-0c90-4019-8b60-b2ed09c624f3"
],
"Opportunities": [
"790d4c92-d0d2-4229-8f6c-48b881b537c4",
"87097b19-d236-409e-a1fc-78a76cd6dcf2"
]
}
}
]