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": "e1fe1952-e639-410b-8a86-17a68b8d347e",
"SeriesId": "f1cf9469-4e1f-4651-a128-49cbcc640d74",
"AccessorID": "110e2523-dda0-425a-b0ed-e0d0d5cd62a6",
"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": "d5da9dc6-e543-4c4e-9aa4-9c9745e92a6f",
"ScheduledByID": "b2750951-9869-4cc7-b752-fb9b3da38f81",
"DeletedDates": [
"2026-04-27T07:03:06Z",
"2026-04-27T07:03:06Z"
],
"ClearedDates": [
"2026-04-27T07:03:06Z",
"2026-04-27T07:03:06Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-27T07:03:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T07:03:06Z",
"CreateDate": "2026-04-27T07:03:06Z",
"OccurTime": "2026-04-27T07:03:06Z",
"OccurEndTime": "2026-04-27T07:03:06Z",
"StartTime": "2026-04-27T07:03:06Z",
"EndTime": "2026-04-27T07:03:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b35206a7-0637-4129-91ff-a4545126bb12",
"9541eff7-5847-4568-8a67-65cb6faa5720"
],
"Companies": [
"ac0bde28-faff-4508-9377-a842fd415da1",
"f17c78d8-d7c6-4517-9e44-1e5fe80a6d62"
],
"Groups": [
"1c21165d-cd05-443f-bf3d-f6e3da443f37",
"431a2c93-edb5-441a-9823-ab69faf62ecd"
],
"Opportunities": [
"266fb7e6-f815-4fa1-8925-343b26cf7189",
"a8f95673-262e-46f6-876c-6343d7c0a353"
]
}
},
{
"Id": "e1fe1952-e639-410b-8a86-17a68b8d347e",
"SeriesId": "f1cf9469-4e1f-4651-a128-49cbcc640d74",
"AccessorID": "110e2523-dda0-425a-b0ed-e0d0d5cd62a6",
"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": "d5da9dc6-e543-4c4e-9aa4-9c9745e92a6f",
"ScheduledByID": "b2750951-9869-4cc7-b752-fb9b3da38f81",
"DeletedDates": [
"2026-04-27T07:03:06Z",
"2026-04-27T07:03:06Z"
],
"ClearedDates": [
"2026-04-27T07:03:06Z",
"2026-04-27T07:03:06Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-27T07:03:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T07:03:06Z",
"CreateDate": "2026-04-27T07:03:06Z",
"OccurTime": "2026-04-27T07:03:06Z",
"OccurEndTime": "2026-04-27T07:03:06Z",
"StartTime": "2026-04-27T07:03:06Z",
"EndTime": "2026-04-27T07:03:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b35206a7-0637-4129-91ff-a4545126bb12",
"9541eff7-5847-4568-8a67-65cb6faa5720"
],
"Companies": [
"ac0bde28-faff-4508-9377-a842fd415da1",
"f17c78d8-d7c6-4517-9e44-1e5fe80a6d62"
],
"Groups": [
"1c21165d-cd05-443f-bf3d-f6e3da443f37",
"431a2c93-edb5-441a-9823-ab69faf62ecd"
],
"Opportunities": [
"266fb7e6-f815-4fa1-8925-343b26cf7189",
"a8f95673-262e-46f6-876c-6343d7c0a353"
]
}
}
]