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": "f169435d-1dab-4c8c-a53f-49c40fa77e09",
"SeriesId": "b10b407c-b99d-4069-aa17-cdf1c9c46549",
"AccessorID": "8342b2d1-5aba-4167-8f4f-db47dbb2ad29",
"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": "27990f88-90d0-45f6-a92e-d0c8b857add7",
"ScheduledByID": "fce22374-bd82-4582-838c-208b5d84cd25",
"DeletedDates": [
"2026-11-15T16:38:35Z",
"2026-11-15T16:38:35Z"
],
"ClearedDates": [
"2026-11-15T16:38:35Z",
"2026-11-15T16:38:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-15T16:38:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-15T16:38:35Z",
"CreateDate": "2026-11-15T16:38:35Z",
"OccurTime": "2026-11-15T16:38:35Z",
"OccurEndTime": "2026-11-15T16:38:35Z",
"StartTime": "2026-11-15T16:38:35Z",
"EndTime": "2026-11-15T16:38:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3ade880b-909e-4cd1-b585-da93952cbf74",
"e34c495e-767c-4a98-ac45-f5e853211e35"
],
"Companies": [
"b5512064-9fee-4a43-ac0a-91692675990a",
"1b26cbd2-4468-4af5-92a6-9ae6070b5d3a"
],
"Groups": [
"acbce297-81ce-4494-8873-03891e308355",
"85530fc7-452c-48ab-86dc-311ecc3519be"
],
"Opportunities": [
"f4ecec46-4286-47d0-8abc-c7cc1236f9ef",
"0c245adb-7a1c-4ce5-aaa2-ac707f45d0ed"
]
}
},
{
"Id": "f169435d-1dab-4c8c-a53f-49c40fa77e09",
"SeriesId": "b10b407c-b99d-4069-aa17-cdf1c9c46549",
"AccessorID": "8342b2d1-5aba-4167-8f4f-db47dbb2ad29",
"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": "27990f88-90d0-45f6-a92e-d0c8b857add7",
"ScheduledByID": "fce22374-bd82-4582-838c-208b5d84cd25",
"DeletedDates": [
"2026-11-15T16:38:35Z",
"2026-11-15T16:38:35Z"
],
"ClearedDates": [
"2026-11-15T16:38:35Z",
"2026-11-15T16:38:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-15T16:38:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-15T16:38:35Z",
"CreateDate": "2026-11-15T16:38:35Z",
"OccurTime": "2026-11-15T16:38:35Z",
"OccurEndTime": "2026-11-15T16:38:35Z",
"StartTime": "2026-11-15T16:38:35Z",
"EndTime": "2026-11-15T16:38:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3ade880b-909e-4cd1-b585-da93952cbf74",
"e34c495e-767c-4a98-ac45-f5e853211e35"
],
"Companies": [
"b5512064-9fee-4a43-ac0a-91692675990a",
"1b26cbd2-4468-4af5-92a6-9ae6070b5d3a"
],
"Groups": [
"acbce297-81ce-4494-8873-03891e308355",
"85530fc7-452c-48ab-86dc-311ecc3519be"
],
"Opportunities": [
"f4ecec46-4286-47d0-8abc-c7cc1236f9ef",
"0c245adb-7a1c-4ce5-aaa2-ac707f45d0ed"
]
}
}
]