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": "7c689fb8-4b31-47b4-9a2d-50f28a4cbeb9",
"SeriesId": "9be5621b-21e6-491b-8d32-a3783b468010",
"AccessorID": "06c61a38-ba62-4b72-b2d2-725c870b5640",
"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": "d31fc572-8bb2-445d-8191-7f6a9e7d1285",
"ScheduledByID": "b331ee23-39a5-4f5c-9e54-d238a7d4f63b",
"DeletedDates": [
"2026-07-11T08:28:35Z",
"2026-07-11T08:28:35Z"
],
"ClearedDates": [
"2026-07-11T08:28:35Z",
"2026-07-11T08:28:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-11T08:28:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-11T08:28:35Z",
"CreateDate": "2026-07-11T08:28:35Z",
"OccurTime": "2026-07-11T08:28:35Z",
"OccurEndTime": "2026-07-11T08:28:35Z",
"StartTime": "2026-07-11T08:28:35Z",
"EndTime": "2026-07-11T08:28:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d95d8a77-580a-43e6-a8ee-777c8ee3d9f2",
"30aa2874-ff5e-4ca4-8e7d-da99d8e29e5f"
],
"Companies": [
"ef354f75-2402-43c6-ab48-fe71f1670974",
"1a345d00-2309-4aff-880f-df34319dca89"
],
"Groups": [
"50ca60b9-80df-4566-a9e5-58fd622320af",
"75028435-d45c-4322-a1be-e72a3aefa0b0"
],
"Opportunities": [
"c81cf9db-5f82-4f15-9993-12ba45a73cd0",
"d209edd1-9705-486a-ac4c-709587ae0a8f"
]
}
},
{
"Id": "7c689fb8-4b31-47b4-9a2d-50f28a4cbeb9",
"SeriesId": "9be5621b-21e6-491b-8d32-a3783b468010",
"AccessorID": "06c61a38-ba62-4b72-b2d2-725c870b5640",
"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": "d31fc572-8bb2-445d-8191-7f6a9e7d1285",
"ScheduledByID": "b331ee23-39a5-4f5c-9e54-d238a7d4f63b",
"DeletedDates": [
"2026-07-11T08:28:35Z",
"2026-07-11T08:28:35Z"
],
"ClearedDates": [
"2026-07-11T08:28:35Z",
"2026-07-11T08:28:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-11T08:28:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-11T08:28:35Z",
"CreateDate": "2026-07-11T08:28:35Z",
"OccurTime": "2026-07-11T08:28:35Z",
"OccurEndTime": "2026-07-11T08:28:35Z",
"StartTime": "2026-07-11T08:28:35Z",
"EndTime": "2026-07-11T08:28:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d95d8a77-580a-43e6-a8ee-777c8ee3d9f2",
"30aa2874-ff5e-4ca4-8e7d-da99d8e29e5f"
],
"Companies": [
"ef354f75-2402-43c6-ab48-fe71f1670974",
"1a345d00-2309-4aff-880f-df34319dca89"
],
"Groups": [
"50ca60b9-80df-4566-a9e5-58fd622320af",
"75028435-d45c-4322-a1be-e72a3aefa0b0"
],
"Opportunities": [
"c81cf9db-5f82-4f15-9993-12ba45a73cd0",
"d209edd1-9705-486a-ac4c-709587ae0a8f"
]
}
}
]