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": "df065a86-9d4c-4c80-9ce1-f7d1bd7fa32e",
"SeriesId": "77d54bf0-7ddd-4df6-b71c-2d8e7c9beee7",
"AccessorID": "0df53caf-4770-45a1-9876-b1ce9899f4fb",
"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": "d5ce5848-c74d-4cff-bee4-0e47ee8b324c",
"ScheduledByID": "287fdd09-9727-4d0f-a2b2-2e6a5d9cc3fc",
"DeletedDates": [
"2026-09-19T16:36:39Z",
"2026-09-19T16:36:39Z"
],
"ClearedDates": [
"2026-09-19T16:36:39Z",
"2026-09-19T16:36:39Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-19T16:36:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-19T16:36:39Z",
"CreateDate": "2026-09-19T16:36:39Z",
"OccurTime": "2026-09-19T16:36:39Z",
"OccurEndTime": "2026-09-19T16:36:39Z",
"StartTime": "2026-09-19T16:36:39Z",
"EndTime": "2026-09-19T16:36:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"205fda5c-8474-4b44-b9b7-c6acb906caf1",
"2eb776b4-4cb1-4b51-ac43-afd0d7233d90"
],
"Companies": [
"b326658f-2aca-4f41-8f81-9aa4064acd72",
"b662d304-c81c-42cd-aa11-14f27973cc9a"
],
"Groups": [
"b6fddf8e-75e9-4504-ab5a-6189722375d2",
"5924c20f-4472-4b11-b148-7667edefb9b6"
],
"Opportunities": [
"314b8166-1efc-47a8-9e25-c7b96e535dc8",
"2ebd752f-e4d8-46b1-8514-8c5030a9ebdd"
]
}
},
{
"Id": "df065a86-9d4c-4c80-9ce1-f7d1bd7fa32e",
"SeriesId": "77d54bf0-7ddd-4df6-b71c-2d8e7c9beee7",
"AccessorID": "0df53caf-4770-45a1-9876-b1ce9899f4fb",
"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": "d5ce5848-c74d-4cff-bee4-0e47ee8b324c",
"ScheduledByID": "287fdd09-9727-4d0f-a2b2-2e6a5d9cc3fc",
"DeletedDates": [
"2026-09-19T16:36:39Z",
"2026-09-19T16:36:39Z"
],
"ClearedDates": [
"2026-09-19T16:36:39Z",
"2026-09-19T16:36:39Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-19T16:36:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-19T16:36:39Z",
"CreateDate": "2026-09-19T16:36:39Z",
"OccurTime": "2026-09-19T16:36:39Z",
"OccurEndTime": "2026-09-19T16:36:39Z",
"StartTime": "2026-09-19T16:36:39Z",
"EndTime": "2026-09-19T16:36:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"205fda5c-8474-4b44-b9b7-c6acb906caf1",
"2eb776b4-4cb1-4b51-ac43-afd0d7233d90"
],
"Companies": [
"b326658f-2aca-4f41-8f81-9aa4064acd72",
"b662d304-c81c-42cd-aa11-14f27973cc9a"
],
"Groups": [
"b6fddf8e-75e9-4504-ab5a-6189722375d2",
"5924c20f-4472-4b11-b148-7667edefb9b6"
],
"Opportunities": [
"314b8166-1efc-47a8-9e25-c7b96e535dc8",
"2ebd752f-e4d8-46b1-8514-8c5030a9ebdd"
]
}
}
]