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": "a858e121-9d40-4454-ad1e-b1e612558c35",
"SeriesId": "62787b4d-c30e-4f5a-b417-24324174ec43",
"AccessorID": "cd21ac5b-fe97-4b4e-b21f-1ce7122be729",
"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": "32c355dc-a39f-4ef9-ac65-d65ec7393b31",
"ScheduledByID": "bc65e68d-c566-470f-a787-73a7077bcec8",
"DeletedDates": [
"2026-07-20T07:22:08Z",
"2026-07-20T07:22:08Z"
],
"ClearedDates": [
"2026-07-20T07:22:08Z",
"2026-07-20T07:22:08Z"
],
"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-20T07:22:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-20T07:22:08Z",
"CreateDate": "2026-07-20T07:22:08Z",
"OccurTime": "2026-07-20T07:22:08Z",
"OccurEndTime": "2026-07-20T07:22:08Z",
"StartTime": "2026-07-20T07:22:08Z",
"EndTime": "2026-07-20T07:22:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7d7a4e0a-50ad-402d-b1a3-d8ac635f1adf",
"6b50beb2-f7e4-4c21-86a1-6e6bc769e946"
],
"Companies": [
"9eb34fd2-2992-46fb-b218-014a7649ffde",
"ebded6eb-271a-4583-bacd-4414bad4b085"
],
"Groups": [
"f906b8c1-c407-488f-a46b-4a135d0f055a",
"b7a72bc1-199e-4835-8fa3-f661f2815254"
],
"Opportunities": [
"9228d999-656a-4e79-be90-21669c6e7ff3",
"5c79d695-ec45-4926-bc94-9343adeb8f3a"
]
}
},
{
"Id": "a858e121-9d40-4454-ad1e-b1e612558c35",
"SeriesId": "62787b4d-c30e-4f5a-b417-24324174ec43",
"AccessorID": "cd21ac5b-fe97-4b4e-b21f-1ce7122be729",
"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": "32c355dc-a39f-4ef9-ac65-d65ec7393b31",
"ScheduledByID": "bc65e68d-c566-470f-a787-73a7077bcec8",
"DeletedDates": [
"2026-07-20T07:22:08Z",
"2026-07-20T07:22:08Z"
],
"ClearedDates": [
"2026-07-20T07:22:08Z",
"2026-07-20T07:22:08Z"
],
"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-20T07:22:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-20T07:22:08Z",
"CreateDate": "2026-07-20T07:22:08Z",
"OccurTime": "2026-07-20T07:22:08Z",
"OccurEndTime": "2026-07-20T07:22:08Z",
"StartTime": "2026-07-20T07:22:08Z",
"EndTime": "2026-07-20T07:22:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7d7a4e0a-50ad-402d-b1a3-d8ac635f1adf",
"6b50beb2-f7e4-4c21-86a1-6e6bc769e946"
],
"Companies": [
"9eb34fd2-2992-46fb-b218-014a7649ffde",
"ebded6eb-271a-4583-bacd-4414bad4b085"
],
"Groups": [
"f906b8c1-c407-488f-a46b-4a135d0f055a",
"b7a72bc1-199e-4835-8fa3-f661f2815254"
],
"Opportunities": [
"9228d999-656a-4e79-be90-21669c6e7ff3",
"5c79d695-ec45-4926-bc94-9343adeb8f3a"
]
}
}
]