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": "4bfb835a-2abf-49a3-ac8c-89ae684640f2",
"SeriesId": "fbf57563-3c94-444d-88ce-617f67902828",
"AccessorID": "992174f0-51ca-4f1b-9ebf-61342e244ab6",
"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": "aa7d1ae9-9170-46e1-8f57-58a7b27741a5",
"ScheduledByID": "cbb7878b-4d3e-4298-9fbc-26b77dd21f2a",
"DeletedDates": [
"2026-11-02T09:10:19Z",
"2026-11-02T09:10:19Z"
],
"ClearedDates": [
"2026-11-02T09:10:19Z",
"2026-11-02T09:10:19Z"
],
"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-02T09:10:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-02T09:10:19Z",
"CreateDate": "2026-11-02T09:10:19Z",
"OccurTime": "2026-11-02T09:10:19Z",
"OccurEndTime": "2026-11-02T09:10:19Z",
"StartTime": "2026-11-02T09:10:19Z",
"EndTime": "2026-11-02T09:10:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ef7d7a3f-59cd-4199-8eaa-a2d80bbbb736",
"d1e1ec14-1c02-407c-bdb6-774d1274043f"
],
"Companies": [
"7f2aea76-b54f-481a-aec0-770937709891",
"dbec5bbd-a2cc-4396-98ce-70070698807c"
],
"Groups": [
"b69f3255-4b05-41fa-b064-eeae50aec564",
"218cc7cd-9e4c-45db-9848-b5d23355741d"
],
"Opportunities": [
"8670fb58-4171-4dc7-9333-f8ec40b1ef8f",
"94e78329-ff9b-4c25-a359-84d55c5efd1d"
]
}
},
{
"Id": "4bfb835a-2abf-49a3-ac8c-89ae684640f2",
"SeriesId": "fbf57563-3c94-444d-88ce-617f67902828",
"AccessorID": "992174f0-51ca-4f1b-9ebf-61342e244ab6",
"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": "aa7d1ae9-9170-46e1-8f57-58a7b27741a5",
"ScheduledByID": "cbb7878b-4d3e-4298-9fbc-26b77dd21f2a",
"DeletedDates": [
"2026-11-02T09:10:19Z",
"2026-11-02T09:10:19Z"
],
"ClearedDates": [
"2026-11-02T09:10:19Z",
"2026-11-02T09:10:19Z"
],
"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-02T09:10:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-02T09:10:19Z",
"CreateDate": "2026-11-02T09:10:19Z",
"OccurTime": "2026-11-02T09:10:19Z",
"OccurEndTime": "2026-11-02T09:10:19Z",
"StartTime": "2026-11-02T09:10:19Z",
"EndTime": "2026-11-02T09:10:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ef7d7a3f-59cd-4199-8eaa-a2d80bbbb736",
"d1e1ec14-1c02-407c-bdb6-774d1274043f"
],
"Companies": [
"7f2aea76-b54f-481a-aec0-770937709891",
"dbec5bbd-a2cc-4396-98ce-70070698807c"
],
"Groups": [
"b69f3255-4b05-41fa-b064-eeae50aec564",
"218cc7cd-9e4c-45db-9848-b5d23355741d"
],
"Opportunities": [
"8670fb58-4171-4dc7-9333-f8ec40b1ef8f",
"94e78329-ff9b-4c25-a359-84d55c5efd1d"
]
}
}
]