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": "17f60cbc-996a-4777-ad51-11cb4ec83c11",
"SeriesId": "c47c8e0e-9d2d-4e89-847e-dfa8ac23042a",
"AccessorID": "29922336-2c4f-42e8-9d91-63c1f0973c66",
"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": "37d807bd-fceb-48ab-9c4e-a0c96dd26901",
"ScheduledByID": "9e95e9f1-9875-4433-93cf-56db5a385998",
"DeletedDates": [
"2026-06-17T00:18:16Z",
"2026-06-17T00:18:16Z"
],
"ClearedDates": [
"2026-06-17T00:18:16Z",
"2026-06-17T00:18:16Z"
],
"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-17T00:18:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-17T00:18:16Z",
"CreateDate": "2026-06-17T00:18:16Z",
"OccurTime": "2026-06-17T00:18:16Z",
"OccurEndTime": "2026-06-17T00:18:16Z",
"StartTime": "2026-06-17T00:18:16Z",
"EndTime": "2026-06-17T00:18:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efbc9c88-1165-4b68-b87f-28ad0ae98446",
"12a92186-ce98-4661-89f5-36f00dce8acd"
],
"Companies": [
"b2c517fb-ca9b-454c-a418-e5496376d980",
"714ca72f-3b1e-429d-8ba8-a648a84b6118"
],
"Groups": [
"282bb2d0-211a-4431-95b7-16c271b1d342",
"70f16317-b997-4029-a55d-d8c39d197d96"
],
"Opportunities": [
"4fd9f786-e2d4-4638-93a5-1f9da9ab16a7",
"4b1431ba-7a82-4f4f-bdf7-0e8978ec0dad"
]
}
},
{
"Id": "17f60cbc-996a-4777-ad51-11cb4ec83c11",
"SeriesId": "c47c8e0e-9d2d-4e89-847e-dfa8ac23042a",
"AccessorID": "29922336-2c4f-42e8-9d91-63c1f0973c66",
"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": "37d807bd-fceb-48ab-9c4e-a0c96dd26901",
"ScheduledByID": "9e95e9f1-9875-4433-93cf-56db5a385998",
"DeletedDates": [
"2026-06-17T00:18:16Z",
"2026-06-17T00:18:16Z"
],
"ClearedDates": [
"2026-06-17T00:18:16Z",
"2026-06-17T00:18:16Z"
],
"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-17T00:18:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-17T00:18:16Z",
"CreateDate": "2026-06-17T00:18:16Z",
"OccurTime": "2026-06-17T00:18:16Z",
"OccurEndTime": "2026-06-17T00:18:16Z",
"StartTime": "2026-06-17T00:18:16Z",
"EndTime": "2026-06-17T00:18:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efbc9c88-1165-4b68-b87f-28ad0ae98446",
"12a92186-ce98-4661-89f5-36f00dce8acd"
],
"Companies": [
"b2c517fb-ca9b-454c-a418-e5496376d980",
"714ca72f-3b1e-429d-8ba8-a648a84b6118"
],
"Groups": [
"282bb2d0-211a-4431-95b7-16c271b1d342",
"70f16317-b997-4029-a55d-d8c39d197d96"
],
"Opportunities": [
"4fd9f786-e2d4-4638-93a5-1f9da9ab16a7",
"4b1431ba-7a82-4f4f-bdf7-0e8978ec0dad"
]
}
}
]