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": "5fb61451-8012-4887-9c63-342a21965d05",
"SeriesId": "603a42dc-1a80-41c5-9cc2-26b4de7945e0",
"AccessorID": "c1a80d03-429a-45eb-9ddd-99365c1140ce",
"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": "51be651c-3862-4518-89b5-0c42305db3a4",
"ScheduledByID": "e1d318da-eca1-4138-ac14-a3ec7d608d99",
"DeletedDates": [
"2026-07-24T12:56:10Z",
"2026-07-24T12:56:10Z"
],
"ClearedDates": [
"2026-07-24T12:56:10Z",
"2026-07-24T12:56:10Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-24T12:56:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-24T12:56:10Z",
"CreateDate": "2026-07-24T12:56:10Z",
"OccurTime": "2026-07-24T12:56:10Z",
"OccurEndTime": "2026-07-24T12:56:10Z",
"StartTime": "2026-07-24T12:56:10Z",
"EndTime": "2026-07-24T12:56:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f31d507-a7f2-490f-8cc1-1b2032bdff12",
"a69a435a-ce74-4cc1-a70b-cf112618ed81"
],
"Companies": [
"a455fa9f-a45d-47c3-aa83-fb90cbc45041",
"c33dc16d-54a8-4a94-aba7-3b1f7a1e13fb"
],
"Groups": [
"7ab70782-f478-4c01-9979-3c4c00348e1f",
"c812aec1-8d79-4174-84b6-315dbe0b8986"
],
"Opportunities": [
"78476457-a2a1-4c49-a267-dbcaea0dd466",
"bbf431bb-996e-4572-a2e0-081b32b8cc23"
]
}
},
{
"Id": "5fb61451-8012-4887-9c63-342a21965d05",
"SeriesId": "603a42dc-1a80-41c5-9cc2-26b4de7945e0",
"AccessorID": "c1a80d03-429a-45eb-9ddd-99365c1140ce",
"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": "51be651c-3862-4518-89b5-0c42305db3a4",
"ScheduledByID": "e1d318da-eca1-4138-ac14-a3ec7d608d99",
"DeletedDates": [
"2026-07-24T12:56:10Z",
"2026-07-24T12:56:10Z"
],
"ClearedDates": [
"2026-07-24T12:56:10Z",
"2026-07-24T12:56:10Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-24T12:56:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-24T12:56:10Z",
"CreateDate": "2026-07-24T12:56:10Z",
"OccurTime": "2026-07-24T12:56:10Z",
"OccurEndTime": "2026-07-24T12:56:10Z",
"StartTime": "2026-07-24T12:56:10Z",
"EndTime": "2026-07-24T12:56:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f31d507-a7f2-490f-8cc1-1b2032bdff12",
"a69a435a-ce74-4cc1-a70b-cf112618ed81"
],
"Companies": [
"a455fa9f-a45d-47c3-aa83-fb90cbc45041",
"c33dc16d-54a8-4a94-aba7-3b1f7a1e13fb"
],
"Groups": [
"7ab70782-f478-4c01-9979-3c4c00348e1f",
"c812aec1-8d79-4174-84b6-315dbe0b8986"
],
"Opportunities": [
"78476457-a2a1-4c49-a267-dbcaea0dd466",
"bbf431bb-996e-4572-a2e0-081b32b8cc23"
]
}
}
]