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": "44a7429d-cc64-4b14-9e20-dc6735154411",
"SeriesId": "d9f6bdcd-f985-4997-8bae-eba64543d088",
"AccessorID": "8883c446-502f-4f98-8e24-7882dc1743f8",
"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": "76d8c8c5-1fd9-4ecc-a035-b27119cab03b",
"ScheduledByID": "b66b1bab-fd75-4bea-bde0-77412613357e",
"DeletedDates": [
"2026-09-14T11:31:38Z",
"2026-09-14T11:31:38Z"
],
"ClearedDates": [
"2026-09-14T11:31:38Z",
"2026-09-14T11:31:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-14T11:31:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-14T11:31:38Z",
"CreateDate": "2026-09-14T11:31:38Z",
"OccurTime": "2026-09-14T11:31:38Z",
"OccurEndTime": "2026-09-14T11:31:38Z",
"StartTime": "2026-09-14T11:31:38Z",
"EndTime": "2026-09-14T11:31:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7e1a0b0c-373e-4da1-8804-b1bb69fdce2a",
"836ea0ad-0cf4-4a11-bd57-521ea0570706"
],
"Companies": [
"771d5c44-c9b9-417c-95c5-7a21b456c0e5",
"752af060-972a-4fec-9380-5c02d9cd3dda"
],
"Groups": [
"00ccf308-937a-4f71-bda7-9abc02c4e5e3",
"49196058-5aec-4771-aada-09bbbee793d6"
],
"Opportunities": [
"158139c0-3ad6-4eef-81a8-ada5c449c21d",
"e8c1cb66-ef9b-4dfc-91cb-5e9c643238e2"
]
}
},
{
"Id": "44a7429d-cc64-4b14-9e20-dc6735154411",
"SeriesId": "d9f6bdcd-f985-4997-8bae-eba64543d088",
"AccessorID": "8883c446-502f-4f98-8e24-7882dc1743f8",
"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": "76d8c8c5-1fd9-4ecc-a035-b27119cab03b",
"ScheduledByID": "b66b1bab-fd75-4bea-bde0-77412613357e",
"DeletedDates": [
"2026-09-14T11:31:38Z",
"2026-09-14T11:31:38Z"
],
"ClearedDates": [
"2026-09-14T11:31:38Z",
"2026-09-14T11:31:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-14T11:31:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-14T11:31:38Z",
"CreateDate": "2026-09-14T11:31:38Z",
"OccurTime": "2026-09-14T11:31:38Z",
"OccurEndTime": "2026-09-14T11:31:38Z",
"StartTime": "2026-09-14T11:31:38Z",
"EndTime": "2026-09-14T11:31:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7e1a0b0c-373e-4da1-8804-b1bb69fdce2a",
"836ea0ad-0cf4-4a11-bd57-521ea0570706"
],
"Companies": [
"771d5c44-c9b9-417c-95c5-7a21b456c0e5",
"752af060-972a-4fec-9380-5c02d9cd3dda"
],
"Groups": [
"00ccf308-937a-4f71-bda7-9abc02c4e5e3",
"49196058-5aec-4771-aada-09bbbee793d6"
],
"Opportunities": [
"158139c0-3ad6-4eef-81a8-ada5c449c21d",
"e8c1cb66-ef9b-4dfc-91cb-5e9c643238e2"
]
}
}
]