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": "0e0f0868-2a0d-4e83-bfc0-2ce4733fca7d",
"SeriesId": "eb120e8e-a20d-444a-8df2-d130fc0927d6",
"AccessorID": "342af42a-17ce-4490-bf24-be7f6e5b32e8",
"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": "229ef679-704d-431c-9883-617c61450274",
"ScheduledByID": "eb55f706-6224-4557-9423-64f4d9b84812",
"DeletedDates": [
"2026-08-05T23:40:18Z",
"2026-08-05T23:40:18Z"
],
"ClearedDates": [
"2026-08-05T23:40:18Z",
"2026-08-05T23:40:18Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-05T23:40:18Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-05T23:40:18Z",
"CreateDate": "2026-08-05T23:40:18Z",
"OccurTime": "2026-08-05T23:40:18Z",
"OccurEndTime": "2026-08-05T23:40:18Z",
"StartTime": "2026-08-05T23:40:18Z",
"EndTime": "2026-08-05T23:40:18Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c7e830f7-04f2-437c-bda1-d1d719c36aee",
"16192901-dd68-492c-8e64-66ee03daa7b6"
],
"Companies": [
"3eb53f8f-0fa4-415f-8dea-a6e3322ccb88",
"984cc0c8-d77a-4027-936a-7b272693c418"
],
"Groups": [
"dd7fa5da-d783-4ca3-b2d1-b05ffad2a1d8",
"adcc5c82-a0f9-4b37-bc99-db15ba2d916a"
],
"Opportunities": [
"cb564fd0-cecd-40b4-b619-53c900f53c8d",
"787910f3-5049-4d05-9b28-05482a704350"
]
}
},
{
"Id": "0e0f0868-2a0d-4e83-bfc0-2ce4733fca7d",
"SeriesId": "eb120e8e-a20d-444a-8df2-d130fc0927d6",
"AccessorID": "342af42a-17ce-4490-bf24-be7f6e5b32e8",
"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": "229ef679-704d-431c-9883-617c61450274",
"ScheduledByID": "eb55f706-6224-4557-9423-64f4d9b84812",
"DeletedDates": [
"2026-08-05T23:40:18Z",
"2026-08-05T23:40:18Z"
],
"ClearedDates": [
"2026-08-05T23:40:18Z",
"2026-08-05T23:40:18Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-05T23:40:18Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-05T23:40:18Z",
"CreateDate": "2026-08-05T23:40:18Z",
"OccurTime": "2026-08-05T23:40:18Z",
"OccurEndTime": "2026-08-05T23:40:18Z",
"StartTime": "2026-08-05T23:40:18Z",
"EndTime": "2026-08-05T23:40:18Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c7e830f7-04f2-437c-bda1-d1d719c36aee",
"16192901-dd68-492c-8e64-66ee03daa7b6"
],
"Companies": [
"3eb53f8f-0fa4-415f-8dea-a6e3322ccb88",
"984cc0c8-d77a-4027-936a-7b272693c418"
],
"Groups": [
"dd7fa5da-d783-4ca3-b2d1-b05ffad2a1d8",
"adcc5c82-a0f9-4b37-bc99-db15ba2d916a"
],
"Opportunities": [
"cb564fd0-cecd-40b4-b619-53c900f53c8d",
"787910f3-5049-4d05-9b28-05482a704350"
]
}
}
]