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": "edf6dd3f-64c4-4d4c-b6e5-c84c2a66adf9",
"SeriesId": "1cc38539-f652-47f1-b59c-0678b7ea1374",
"AccessorID": "f3b86bbc-b264-4707-8708-3a452e0867d3",
"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": "dadaacce-2b37-4ef2-8ef0-05db01edb1f4",
"ScheduledByID": "d677091d-eba5-44f4-8e68-ffae56c9721c",
"DeletedDates": [
"2026-06-24T07:58:12Z",
"2026-06-24T07:58:12Z"
],
"ClearedDates": [
"2026-06-24T07:58:12Z",
"2026-06-24T07:58:12Z"
],
"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-24T07:58:12Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-24T07:58:12Z",
"CreateDate": "2026-06-24T07:58:12Z",
"OccurTime": "2026-06-24T07:58:12Z",
"OccurEndTime": "2026-06-24T07:58:12Z",
"StartTime": "2026-06-24T07:58:12Z",
"EndTime": "2026-06-24T07:58:12Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f3b3bf8e-f979-4a39-b55d-38eb039ad56b",
"83a867e2-6590-447b-b1d6-47315261e546"
],
"Companies": [
"79bb6164-4933-4014-a9c2-0b75341e3cac",
"83188490-d91b-4553-8749-1f3be3742b6c"
],
"Groups": [
"30af21da-13e1-4dd5-b537-6b1b6caa6526",
"63d49bf2-738a-4dd6-84b1-a99acd7b3fb4"
],
"Opportunities": [
"a9dc0849-3550-4874-af54-81bb5265b2f1",
"cc7d5c61-75a7-42d5-aa2b-fd8b59eb81b3"
]
}
},
{
"Id": "edf6dd3f-64c4-4d4c-b6e5-c84c2a66adf9",
"SeriesId": "1cc38539-f652-47f1-b59c-0678b7ea1374",
"AccessorID": "f3b86bbc-b264-4707-8708-3a452e0867d3",
"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": "dadaacce-2b37-4ef2-8ef0-05db01edb1f4",
"ScheduledByID": "d677091d-eba5-44f4-8e68-ffae56c9721c",
"DeletedDates": [
"2026-06-24T07:58:12Z",
"2026-06-24T07:58:12Z"
],
"ClearedDates": [
"2026-06-24T07:58:12Z",
"2026-06-24T07:58:12Z"
],
"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-24T07:58:12Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-24T07:58:12Z",
"CreateDate": "2026-06-24T07:58:12Z",
"OccurTime": "2026-06-24T07:58:12Z",
"OccurEndTime": "2026-06-24T07:58:12Z",
"StartTime": "2026-06-24T07:58:12Z",
"EndTime": "2026-06-24T07:58:12Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f3b3bf8e-f979-4a39-b55d-38eb039ad56b",
"83a867e2-6590-447b-b1d6-47315261e546"
],
"Companies": [
"79bb6164-4933-4014-a9c2-0b75341e3cac",
"83188490-d91b-4553-8749-1f3be3742b6c"
],
"Groups": [
"30af21da-13e1-4dd5-b537-6b1b6caa6526",
"63d49bf2-738a-4dd6-84b1-a99acd7b3fb4"
],
"Opportunities": [
"a9dc0849-3550-4874-af54-81bb5265b2f1",
"cc7d5c61-75a7-42d5-aa2b-fd8b59eb81b3"
]
}
}
]