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": "328f3c55-fd1c-4ad2-af0d-af818be5f153",
"SeriesId": "febcd8b8-d13d-462c-bcfa-315f10e41b66",
"AccessorID": "6bc43d02-23aa-43a5-a4c1-c559dc610f3c",
"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": "bb56b318-76fe-4d5f-ad28-367479a3798f",
"ScheduledByID": "d4f495f2-2875-4c9f-b0b1-8583aff58602",
"DeletedDates": [
"2026-07-04T20:28:47Z",
"2026-07-04T20:28:47Z"
],
"ClearedDates": [
"2026-07-04T20:28:47Z",
"2026-07-04T20:28:47Z"
],
"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-04T20:28:47Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-04T20:28:47Z",
"CreateDate": "2026-07-04T20:28:47Z",
"OccurTime": "2026-07-04T20:28:47Z",
"OccurEndTime": "2026-07-04T20:28:47Z",
"StartTime": "2026-07-04T20:28:47Z",
"EndTime": "2026-07-04T20:28:47Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"86e2a4bb-b84d-457c-9110-272967d2e634",
"3eefc9d8-f3a4-4220-804e-2677cc833ccd"
],
"Companies": [
"1365820a-275c-4480-9c1b-31dd50ee3685",
"db8fa3f0-3196-4846-bc41-10cdb5cf2f89"
],
"Groups": [
"dd25eb7e-5631-496b-a257-9fbe57b91b73",
"cd597de6-9b04-4e43-b50e-10f82997ac76"
],
"Opportunities": [
"f28af5f9-325d-4900-84fb-e0e68ae9138b",
"6275c01e-f5c0-4608-b69b-fe9679d3a7a7"
]
}
},
{
"Id": "328f3c55-fd1c-4ad2-af0d-af818be5f153",
"SeriesId": "febcd8b8-d13d-462c-bcfa-315f10e41b66",
"AccessorID": "6bc43d02-23aa-43a5-a4c1-c559dc610f3c",
"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": "bb56b318-76fe-4d5f-ad28-367479a3798f",
"ScheduledByID": "d4f495f2-2875-4c9f-b0b1-8583aff58602",
"DeletedDates": [
"2026-07-04T20:28:47Z",
"2026-07-04T20:28:47Z"
],
"ClearedDates": [
"2026-07-04T20:28:47Z",
"2026-07-04T20:28:47Z"
],
"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-04T20:28:47Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-04T20:28:47Z",
"CreateDate": "2026-07-04T20:28:47Z",
"OccurTime": "2026-07-04T20:28:47Z",
"OccurEndTime": "2026-07-04T20:28:47Z",
"StartTime": "2026-07-04T20:28:47Z",
"EndTime": "2026-07-04T20:28:47Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"86e2a4bb-b84d-457c-9110-272967d2e634",
"3eefc9d8-f3a4-4220-804e-2677cc833ccd"
],
"Companies": [
"1365820a-275c-4480-9c1b-31dd50ee3685",
"db8fa3f0-3196-4846-bc41-10cdb5cf2f89"
],
"Groups": [
"dd25eb7e-5631-496b-a257-9fbe57b91b73",
"cd597de6-9b04-4e43-b50e-10f82997ac76"
],
"Opportunities": [
"f28af5f9-325d-4900-84fb-e0e68ae9138b",
"6275c01e-f5c0-4608-b69b-fe9679d3a7a7"
]
}
}
]