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": "e24cbf2d-bbd7-4057-94fc-35e023031baa",
"SeriesId": "b5b391dd-5051-4570-8100-c8af5dc7ca61",
"AccessorID": "db256ee8-b088-469c-9552-55252bbf2015",
"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": "9e9bed39-65c4-44f0-9cb4-26f4d148163c",
"ScheduledByID": "5f1b848f-889a-42ad-8039-7c258d8d13ed",
"DeletedDates": [
"2026-04-19T10:35:17Z",
"2026-04-19T10:35:17Z"
],
"ClearedDates": [
"2026-04-19T10:35:17Z",
"2026-04-19T10:35:17Z"
],
"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-19T10:35:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-19T10:35:17Z",
"CreateDate": "2026-04-19T10:35:17Z",
"OccurTime": "2026-04-19T10:35:17Z",
"OccurEndTime": "2026-04-19T10:35:17Z",
"StartTime": "2026-04-19T10:35:17Z",
"EndTime": "2026-04-19T10:35:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ed540d58-bddb-4efa-acd9-dfb47f931d26",
"f57399d8-1885-4905-830a-6969519eaaa9"
],
"Companies": [
"f0903f4c-ac89-404c-9c27-fac349c024db",
"e2742e4e-2348-48c4-9689-3bdd9a0757da"
],
"Groups": [
"3dc768a2-e6ef-4b3c-a1cc-0c03e8577779",
"06768440-d556-484d-a8a3-a182048617d8"
],
"Opportunities": [
"818401db-1974-4fd6-b138-a35f209d90f2",
"3a2669c9-487b-4d19-95d8-b483324ba757"
]
}
},
{
"Id": "e24cbf2d-bbd7-4057-94fc-35e023031baa",
"SeriesId": "b5b391dd-5051-4570-8100-c8af5dc7ca61",
"AccessorID": "db256ee8-b088-469c-9552-55252bbf2015",
"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": "9e9bed39-65c4-44f0-9cb4-26f4d148163c",
"ScheduledByID": "5f1b848f-889a-42ad-8039-7c258d8d13ed",
"DeletedDates": [
"2026-04-19T10:35:17Z",
"2026-04-19T10:35:17Z"
],
"ClearedDates": [
"2026-04-19T10:35:17Z",
"2026-04-19T10:35:17Z"
],
"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-19T10:35:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-19T10:35:17Z",
"CreateDate": "2026-04-19T10:35:17Z",
"OccurTime": "2026-04-19T10:35:17Z",
"OccurEndTime": "2026-04-19T10:35:17Z",
"StartTime": "2026-04-19T10:35:17Z",
"EndTime": "2026-04-19T10:35:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ed540d58-bddb-4efa-acd9-dfb47f931d26",
"f57399d8-1885-4905-830a-6969519eaaa9"
],
"Companies": [
"f0903f4c-ac89-404c-9c27-fac349c024db",
"e2742e4e-2348-48c4-9689-3bdd9a0757da"
],
"Groups": [
"3dc768a2-e6ef-4b3c-a1cc-0c03e8577779",
"06768440-d556-484d-a8a3-a182048617d8"
],
"Opportunities": [
"818401db-1974-4fd6-b138-a35f209d90f2",
"3a2669c9-487b-4d19-95d8-b483324ba757"
]
}
}
]