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": "0ee0b231-8de8-45af-87d4-12913c419d45",
"SeriesId": "9c48babf-154a-4d70-b150-a17fc6a573a1",
"AccessorID": "74e4ca85-4ea7-4f53-b9a6-32839fa6d0f8",
"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": "af40e2da-a305-4a73-bd55-b2c72e0b8823",
"ScheduledByID": "26492ac5-892c-47a9-84c3-8aef616a18f5",
"DeletedDates": [
"2026-06-16T00:06:07Z",
"2026-06-16T00:06:07Z"
],
"ClearedDates": [
"2026-06-16T00:06:07Z",
"2026-06-16T00:06:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-16T00:06:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-16T00:06:07Z",
"CreateDate": "2026-06-16T00:06:07Z",
"OccurTime": "2026-06-16T00:06:07Z",
"OccurEndTime": "2026-06-16T00:06:07Z",
"StartTime": "2026-06-16T00:06:07Z",
"EndTime": "2026-06-16T00:06:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4fa53342-2a16-49c2-8c2a-6154b98629ae",
"532bd7bb-6621-4350-803b-bd4240d8c31f"
],
"Companies": [
"69470c9b-3b16-4d07-a396-b741c28acd59",
"35f9189f-3f42-416f-8d1e-816eeb0a34ef"
],
"Groups": [
"c56b4cb9-5618-45bb-ac73-e08f31656a55",
"bd0ab3b7-529a-4971-ba71-66c21ba6dc56"
],
"Opportunities": [
"6e564489-9d3c-47e6-a570-c344983ebbc9",
"c763b749-6aae-466c-af25-d06a7cafec8b"
]
}
},
{
"Id": "0ee0b231-8de8-45af-87d4-12913c419d45",
"SeriesId": "9c48babf-154a-4d70-b150-a17fc6a573a1",
"AccessorID": "74e4ca85-4ea7-4f53-b9a6-32839fa6d0f8",
"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": "af40e2da-a305-4a73-bd55-b2c72e0b8823",
"ScheduledByID": "26492ac5-892c-47a9-84c3-8aef616a18f5",
"DeletedDates": [
"2026-06-16T00:06:07Z",
"2026-06-16T00:06:07Z"
],
"ClearedDates": [
"2026-06-16T00:06:07Z",
"2026-06-16T00:06:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-16T00:06:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-16T00:06:07Z",
"CreateDate": "2026-06-16T00:06:07Z",
"OccurTime": "2026-06-16T00:06:07Z",
"OccurEndTime": "2026-06-16T00:06:07Z",
"StartTime": "2026-06-16T00:06:07Z",
"EndTime": "2026-06-16T00:06:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4fa53342-2a16-49c2-8c2a-6154b98629ae",
"532bd7bb-6621-4350-803b-bd4240d8c31f"
],
"Companies": [
"69470c9b-3b16-4d07-a396-b741c28acd59",
"35f9189f-3f42-416f-8d1e-816eeb0a34ef"
],
"Groups": [
"c56b4cb9-5618-45bb-ac73-e08f31656a55",
"bd0ab3b7-529a-4971-ba71-66c21ba6dc56"
],
"Opportunities": [
"6e564489-9d3c-47e6-a570-c344983ebbc9",
"c763b749-6aae-466c-af25-d06a7cafec8b"
]
}
}
]