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": "89d684fc-4efd-4240-918b-f59d60791d59",
"SeriesId": "44964176-b7ea-4fac-899f-4f393c5138cf",
"AccessorID": "77208a2d-6424-420c-8f0f-f8af954115ae",
"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": "5e8a4c1e-18e6-44db-9154-35b0b4c93fb9",
"ScheduledByID": "6a97cb5d-3b6e-4d4c-ab87-8207b4a74a20",
"DeletedDates": [
"2026-10-30T07:54:52Z",
"2026-10-30T07:54:52Z"
],
"ClearedDates": [
"2026-10-30T07:54:52Z",
"2026-10-30T07:54:52Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-30T07:54:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-30T07:54:52Z",
"CreateDate": "2026-10-30T07:54:52Z",
"OccurTime": "2026-10-30T07:54:52Z",
"OccurEndTime": "2026-10-30T07:54:52Z",
"StartTime": "2026-10-30T07:54:52Z",
"EndTime": "2026-10-30T07:54:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8c5eff57-3028-46b1-a138-bf0b75b64647",
"862e4349-1a8f-479b-82c7-78ed1b25a1fd"
],
"Companies": [
"68b30928-b812-4890-bc97-d7d607b07554",
"0eb70aff-6a31-4d5d-b8cc-cc824691d7ca"
],
"Groups": [
"17c9a320-cda7-414b-9978-3b334e18b14e",
"1f3fc7a8-402b-489a-9bf8-b2f2acc43d2a"
],
"Opportunities": [
"f8c5cf38-007c-4cee-8619-922b24753880",
"504e59ec-d28a-4a49-be9e-06bc12f7bda9"
]
}
},
{
"Id": "89d684fc-4efd-4240-918b-f59d60791d59",
"SeriesId": "44964176-b7ea-4fac-899f-4f393c5138cf",
"AccessorID": "77208a2d-6424-420c-8f0f-f8af954115ae",
"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": "5e8a4c1e-18e6-44db-9154-35b0b4c93fb9",
"ScheduledByID": "6a97cb5d-3b6e-4d4c-ab87-8207b4a74a20",
"DeletedDates": [
"2026-10-30T07:54:52Z",
"2026-10-30T07:54:52Z"
],
"ClearedDates": [
"2026-10-30T07:54:52Z",
"2026-10-30T07:54:52Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-30T07:54:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-30T07:54:52Z",
"CreateDate": "2026-10-30T07:54:52Z",
"OccurTime": "2026-10-30T07:54:52Z",
"OccurEndTime": "2026-10-30T07:54:52Z",
"StartTime": "2026-10-30T07:54:52Z",
"EndTime": "2026-10-30T07:54:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8c5eff57-3028-46b1-a138-bf0b75b64647",
"862e4349-1a8f-479b-82c7-78ed1b25a1fd"
],
"Companies": [
"68b30928-b812-4890-bc97-d7d607b07554",
"0eb70aff-6a31-4d5d-b8cc-cc824691d7ca"
],
"Groups": [
"17c9a320-cda7-414b-9978-3b334e18b14e",
"1f3fc7a8-402b-489a-9bf8-b2f2acc43d2a"
],
"Opportunities": [
"f8c5cf38-007c-4cee-8619-922b24753880",
"504e59ec-d28a-4a49-be9e-06bc12f7bda9"
]
}
}
]