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": "393fcfb7-298d-4112-935a-f36e850c95d2",
"SeriesId": "0160715d-4037-4dd5-ac7e-a80425be3161",
"AccessorID": "2cf874cb-ce7b-4ff7-8df6-284938beac41",
"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": "04679f5e-3164-434b-83e4-b8c2ae79e7af",
"ScheduledByID": "479cf2b5-cd19-49fb-8be8-21f6f19eda3c",
"DeletedDates": [
"2026-11-07T12:42:06Z",
"2026-11-07T12:42:06Z"
],
"ClearedDates": [
"2026-11-07T12:42:06Z",
"2026-11-07T12:42:06Z"
],
"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-07T12:42:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-07T12:42:06Z",
"CreateDate": "2026-11-07T12:42:06Z",
"OccurTime": "2026-11-07T12:42:06Z",
"OccurEndTime": "2026-11-07T12:42:06Z",
"StartTime": "2026-11-07T12:42:06Z",
"EndTime": "2026-11-07T12:42:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9fd410b0-47e7-43a1-9e23-cdec3b6f3222",
"9e2af3a8-3f86-4b2c-81d7-62f8bdfe00ba"
],
"Companies": [
"8f4ffa4e-ecfa-4837-af7d-72eb38c82c27",
"630c6940-f1cc-4bd9-ac0a-7221555d1937"
],
"Groups": [
"cbafc2a4-3c7c-4afb-9f48-c58e1c3086fc",
"b6a1327a-ae89-40af-baa6-a49577a19330"
],
"Opportunities": [
"586f5277-bc66-4451-8e58-b54c23e1f6e0",
"e9c3d1cf-c998-4541-8810-c6b6adfb3d7e"
]
}
},
{
"Id": "393fcfb7-298d-4112-935a-f36e850c95d2",
"SeriesId": "0160715d-4037-4dd5-ac7e-a80425be3161",
"AccessorID": "2cf874cb-ce7b-4ff7-8df6-284938beac41",
"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": "04679f5e-3164-434b-83e4-b8c2ae79e7af",
"ScheduledByID": "479cf2b5-cd19-49fb-8be8-21f6f19eda3c",
"DeletedDates": [
"2026-11-07T12:42:06Z",
"2026-11-07T12:42:06Z"
],
"ClearedDates": [
"2026-11-07T12:42:06Z",
"2026-11-07T12:42:06Z"
],
"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-07T12:42:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-07T12:42:06Z",
"CreateDate": "2026-11-07T12:42:06Z",
"OccurTime": "2026-11-07T12:42:06Z",
"OccurEndTime": "2026-11-07T12:42:06Z",
"StartTime": "2026-11-07T12:42:06Z",
"EndTime": "2026-11-07T12:42:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9fd410b0-47e7-43a1-9e23-cdec3b6f3222",
"9e2af3a8-3f86-4b2c-81d7-62f8bdfe00ba"
],
"Companies": [
"8f4ffa4e-ecfa-4837-af7d-72eb38c82c27",
"630c6940-f1cc-4bd9-ac0a-7221555d1937"
],
"Groups": [
"cbafc2a4-3c7c-4afb-9f48-c58e1c3086fc",
"b6a1327a-ae89-40af-baa6-a49577a19330"
],
"Opportunities": [
"586f5277-bc66-4451-8e58-b54c23e1f6e0",
"e9c3d1cf-c998-4541-8810-c6b6adfb3d7e"
]
}
}
]