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": "608a5780-fb9b-48b9-aacc-2e25747ce996",
"SeriesId": "1174300f-da50-48b3-a497-a8baf2908d0d",
"AccessorID": "c13eb7ea-1be9-4093-84f9-4c33f26ad701",
"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": "1515968d-441f-43e1-95a7-ee3d9e81ec80",
"ScheduledByID": "371f45cf-14a8-428a-9b85-b8370c18cfe1",
"DeletedDates": [
"2026-06-30T16:51:38Z",
"2026-06-30T16:51:38Z"
],
"ClearedDates": [
"2026-06-30T16:51:38Z",
"2026-06-30T16:51:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-30T16:51:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-30T16:51:38Z",
"CreateDate": "2026-06-30T16:51:38Z",
"OccurTime": "2026-06-30T16:51:38Z",
"OccurEndTime": "2026-06-30T16:51:38Z",
"StartTime": "2026-06-30T16:51:38Z",
"EndTime": "2026-06-30T16:51:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b5fc8056-2150-4cda-949f-647bd00152ce",
"95474654-9cf8-4cbb-9491-b316aea2c0f7"
],
"Companies": [
"951113eb-d99e-4ddf-aa96-18aa7546f5e1",
"a84db1d6-0f53-419a-9a3c-557ef1146df4"
],
"Groups": [
"eef12142-c687-4ab8-b7d4-0ccb0fc042fd",
"45951e07-b526-480c-9ab9-9deb8c8bf3bb"
],
"Opportunities": [
"c10ec53c-1511-4061-be61-25306955353a",
"1b5cfa3d-936b-4618-9a1d-1a62d87d12d6"
]
}
},
{
"Id": "608a5780-fb9b-48b9-aacc-2e25747ce996",
"SeriesId": "1174300f-da50-48b3-a497-a8baf2908d0d",
"AccessorID": "c13eb7ea-1be9-4093-84f9-4c33f26ad701",
"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": "1515968d-441f-43e1-95a7-ee3d9e81ec80",
"ScheduledByID": "371f45cf-14a8-428a-9b85-b8370c18cfe1",
"DeletedDates": [
"2026-06-30T16:51:38Z",
"2026-06-30T16:51:38Z"
],
"ClearedDates": [
"2026-06-30T16:51:38Z",
"2026-06-30T16:51:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-30T16:51:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-30T16:51:38Z",
"CreateDate": "2026-06-30T16:51:38Z",
"OccurTime": "2026-06-30T16:51:38Z",
"OccurEndTime": "2026-06-30T16:51:38Z",
"StartTime": "2026-06-30T16:51:38Z",
"EndTime": "2026-06-30T16:51:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b5fc8056-2150-4cda-949f-647bd00152ce",
"95474654-9cf8-4cbb-9491-b316aea2c0f7"
],
"Companies": [
"951113eb-d99e-4ddf-aa96-18aa7546f5e1",
"a84db1d6-0f53-419a-9a3c-557ef1146df4"
],
"Groups": [
"eef12142-c687-4ab8-b7d4-0ccb0fc042fd",
"45951e07-b526-480c-9ab9-9deb8c8bf3bb"
],
"Opportunities": [
"c10ec53c-1511-4061-be61-25306955353a",
"1b5cfa3d-936b-4618-9a1d-1a62d87d12d6"
]
}
}
]