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": "f3d79c9a-4b90-4397-b639-1d26c3a50a32",
"SeriesId": "9cf1fb0e-f167-4f92-856e-c3928c995d25",
"AccessorID": "8ee30cc0-4029-414c-b445-c23ae9c73d93",
"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": "275dee48-f812-4466-8b6b-3d07976fcbd3",
"ScheduledByID": "c0f0340e-a2ae-4099-9b80-623ce037875a",
"DeletedDates": [
"2026-04-17T00:53:13Z",
"2026-04-17T00:53:13Z"
],
"ClearedDates": [
"2026-04-17T00:53:13Z",
"2026-04-17T00:53:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-17T00:53:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-17T00:53:13Z",
"CreateDate": "2026-04-17T00:53:13Z",
"OccurTime": "2026-04-17T00:53:13Z",
"OccurEndTime": "2026-04-17T00:53:13Z",
"StartTime": "2026-04-17T00:53:13Z",
"EndTime": "2026-04-17T00:53:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"79f3dd76-ca3a-4f80-aeb8-e61199dabf2f",
"81297202-9416-4837-ab92-71509bccb020"
],
"Companies": [
"5cf4a84e-396c-4803-8d76-52ec9f8d9300",
"6220e6ce-1984-4922-abbe-358758961f2f"
],
"Groups": [
"64e1b705-8cbe-4e51-82be-711e18a57d3c",
"1109eba5-b612-4734-9ee2-15cf4548fd08"
],
"Opportunities": [
"23564fee-ec13-4acf-b1d5-fe109b6dca2e",
"a4cd6ee5-2c64-48a6-be1d-ae3e175db49e"
]
}
},
{
"Id": "f3d79c9a-4b90-4397-b639-1d26c3a50a32",
"SeriesId": "9cf1fb0e-f167-4f92-856e-c3928c995d25",
"AccessorID": "8ee30cc0-4029-414c-b445-c23ae9c73d93",
"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": "275dee48-f812-4466-8b6b-3d07976fcbd3",
"ScheduledByID": "c0f0340e-a2ae-4099-9b80-623ce037875a",
"DeletedDates": [
"2026-04-17T00:53:13Z",
"2026-04-17T00:53:13Z"
],
"ClearedDates": [
"2026-04-17T00:53:13Z",
"2026-04-17T00:53:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-17T00:53:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-17T00:53:13Z",
"CreateDate": "2026-04-17T00:53:13Z",
"OccurTime": "2026-04-17T00:53:13Z",
"OccurEndTime": "2026-04-17T00:53:13Z",
"StartTime": "2026-04-17T00:53:13Z",
"EndTime": "2026-04-17T00:53:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"79f3dd76-ca3a-4f80-aeb8-e61199dabf2f",
"81297202-9416-4837-ab92-71509bccb020"
],
"Companies": [
"5cf4a84e-396c-4803-8d76-52ec9f8d9300",
"6220e6ce-1984-4922-abbe-358758961f2f"
],
"Groups": [
"64e1b705-8cbe-4e51-82be-711e18a57d3c",
"1109eba5-b612-4734-9ee2-15cf4548fd08"
],
"Opportunities": [
"23564fee-ec13-4acf-b1d5-fe109b6dca2e",
"a4cd6ee5-2c64-48a6-be1d-ae3e175db49e"
]
}
}
]