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": "03391b72-8af8-42c6-baa0-b03b220fd8b9",
"SeriesId": "d1a880a2-8306-4e21-ac2b-5d2042dc1643",
"AccessorID": "56488173-719c-4fe1-8749-5bf973e7a0e5",
"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": "d7d374f4-89ad-45bc-8cea-e635a2ccf0a0",
"ScheduledByID": "abf6e46e-ae57-4544-8c6a-1015024aeaf0",
"DeletedDates": [
"2026-10-29T04:02:40Z",
"2026-10-29T04:02:40Z"
],
"ClearedDates": [
"2026-10-29T04:02:40Z",
"2026-10-29T04:02:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-29T04:02:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-29T04:02:40Z",
"CreateDate": "2026-10-29T04:02:40Z",
"OccurTime": "2026-10-29T04:02:40Z",
"OccurEndTime": "2026-10-29T04:02:40Z",
"StartTime": "2026-10-29T04:02:40Z",
"EndTime": "2026-10-29T04:02:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"551b0ba9-ce9b-4ef2-99ff-67fed5e2e381",
"196c0e65-7c1e-4861-992a-b21531749167"
],
"Companies": [
"436e6bc8-81d0-4b1f-ba46-cd23c083b424",
"39bcdbb1-1b0a-4974-81ca-98b75166b490"
],
"Groups": [
"7482d51c-8e32-4eba-90e4-50465e28022b",
"93ce2a85-20a7-4f69-a5a3-f6009756bb8f"
],
"Opportunities": [
"1a5e9fe2-9bf3-4f32-aa11-80ed80843387",
"ebfc14f7-0d08-47cc-90ad-a0c82d8779d5"
]
}
},
{
"Id": "03391b72-8af8-42c6-baa0-b03b220fd8b9",
"SeriesId": "d1a880a2-8306-4e21-ac2b-5d2042dc1643",
"AccessorID": "56488173-719c-4fe1-8749-5bf973e7a0e5",
"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": "d7d374f4-89ad-45bc-8cea-e635a2ccf0a0",
"ScheduledByID": "abf6e46e-ae57-4544-8c6a-1015024aeaf0",
"DeletedDates": [
"2026-10-29T04:02:40Z",
"2026-10-29T04:02:40Z"
],
"ClearedDates": [
"2026-10-29T04:02:40Z",
"2026-10-29T04:02:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-29T04:02:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-29T04:02:40Z",
"CreateDate": "2026-10-29T04:02:40Z",
"OccurTime": "2026-10-29T04:02:40Z",
"OccurEndTime": "2026-10-29T04:02:40Z",
"StartTime": "2026-10-29T04:02:40Z",
"EndTime": "2026-10-29T04:02:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"551b0ba9-ce9b-4ef2-99ff-67fed5e2e381",
"196c0e65-7c1e-4861-992a-b21531749167"
],
"Companies": [
"436e6bc8-81d0-4b1f-ba46-cd23c083b424",
"39bcdbb1-1b0a-4974-81ca-98b75166b490"
],
"Groups": [
"7482d51c-8e32-4eba-90e4-50465e28022b",
"93ce2a85-20a7-4f69-a5a3-f6009756bb8f"
],
"Opportunities": [
"1a5e9fe2-9bf3-4f32-aa11-80ed80843387",
"ebfc14f7-0d08-47cc-90ad-a0c82d8779d5"
]
}
}
]