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": "a159d730-6d40-4acc-9529-f7d6ae4844eb",
"SeriesId": "8f7e554c-d51b-4c5e-b842-545b8751c864",
"AccessorID": "02de612e-3048-48fa-975c-9e9dbe96a514",
"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": "4065f92c-49ff-4d54-b420-409272c4261a",
"ScheduledByID": "d333e3db-ae5c-49fa-8866-93145264c2f2",
"DeletedDates": [
"2026-09-09T04:09:54Z",
"2026-09-09T04:09:54Z"
],
"ClearedDates": [
"2026-09-09T04:09:54Z",
"2026-09-09T04:09:54Z"
],
"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-09T04:09:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-09T04:09:54Z",
"CreateDate": "2026-09-09T04:09:54Z",
"OccurTime": "2026-09-09T04:09:54Z",
"OccurEndTime": "2026-09-09T04:09:54Z",
"StartTime": "2026-09-09T04:09:54Z",
"EndTime": "2026-09-09T04:09:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"de7b21b7-dd82-4724-b497-d55600c4716a",
"4bebc8cd-3cc2-426f-92f7-2e5e4c117544"
],
"Companies": [
"05545101-0acb-4c1e-b040-ec7d4107e934",
"dc1d360b-9477-411d-a265-a32c7702a430"
],
"Groups": [
"50cb5037-81ef-44e9-9f95-32d46ffe0b0c",
"60563a1b-b61a-4661-b187-5acc95ab0552"
],
"Opportunities": [
"bb2bfe6c-9490-4180-aaea-85d8821aa0ab",
"f8a1290a-7ee5-4dcc-8589-09b77c96e13a"
]
}
},
{
"Id": "a159d730-6d40-4acc-9529-f7d6ae4844eb",
"SeriesId": "8f7e554c-d51b-4c5e-b842-545b8751c864",
"AccessorID": "02de612e-3048-48fa-975c-9e9dbe96a514",
"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": "4065f92c-49ff-4d54-b420-409272c4261a",
"ScheduledByID": "d333e3db-ae5c-49fa-8866-93145264c2f2",
"DeletedDates": [
"2026-09-09T04:09:54Z",
"2026-09-09T04:09:54Z"
],
"ClearedDates": [
"2026-09-09T04:09:54Z",
"2026-09-09T04:09:54Z"
],
"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-09T04:09:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-09T04:09:54Z",
"CreateDate": "2026-09-09T04:09:54Z",
"OccurTime": "2026-09-09T04:09:54Z",
"OccurEndTime": "2026-09-09T04:09:54Z",
"StartTime": "2026-09-09T04:09:54Z",
"EndTime": "2026-09-09T04:09:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"de7b21b7-dd82-4724-b497-d55600c4716a",
"4bebc8cd-3cc2-426f-92f7-2e5e4c117544"
],
"Companies": [
"05545101-0acb-4c1e-b040-ec7d4107e934",
"dc1d360b-9477-411d-a265-a32c7702a430"
],
"Groups": [
"50cb5037-81ef-44e9-9f95-32d46ffe0b0c",
"60563a1b-b61a-4661-b187-5acc95ab0552"
],
"Opportunities": [
"bb2bfe6c-9490-4180-aaea-85d8821aa0ab",
"f8a1290a-7ee5-4dcc-8589-09b77c96e13a"
]
}
}
]