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": "ea637794-ea1e-4322-9c0c-036e85329646",
"SeriesId": "0f82fe29-44dc-4e7e-9bd6-74285f94beb9",
"AccessorID": "317f44ef-1620-406a-a829-4b0622720e55",
"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": "2273331a-1fb5-4cc8-a4da-16a5a4831a8a",
"ScheduledByID": "fe3fbcf9-8159-4a1a-a697-81b8252c856b",
"DeletedDates": [
"2026-08-20T12:00:30Z",
"2026-08-20T12:00:30Z"
],
"ClearedDates": [
"2026-08-20T12:00:30Z",
"2026-08-20T12:00:30Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-20T12:00:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-20T12:00:30Z",
"CreateDate": "2026-08-20T12:00:30Z",
"OccurTime": "2026-08-20T12:00:30Z",
"OccurEndTime": "2026-08-20T12:00:30Z",
"StartTime": "2026-08-20T12:00:30Z",
"EndTime": "2026-08-20T12:00:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6bf53701-7796-4aa2-a816-17784fa6449e",
"c56ca37e-9a3b-42a6-b72d-0ada8504b828"
],
"Companies": [
"d6925a71-d5a2-4eda-9eb4-d539be5d30c3",
"6dad2fb6-b33b-4485-83b1-4f7e62d0a2f5"
],
"Groups": [
"a158655e-f9d7-49e3-9976-7d181b7b0415",
"6c903615-4d61-4ba7-be3e-90623950bd0e"
],
"Opportunities": [
"0c4d0fa9-9601-4c52-b35c-8f73ea828d8d",
"c5802926-3879-48ca-9e42-f2d402d0b0a7"
]
}
},
{
"Id": "ea637794-ea1e-4322-9c0c-036e85329646",
"SeriesId": "0f82fe29-44dc-4e7e-9bd6-74285f94beb9",
"AccessorID": "317f44ef-1620-406a-a829-4b0622720e55",
"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": "2273331a-1fb5-4cc8-a4da-16a5a4831a8a",
"ScheduledByID": "fe3fbcf9-8159-4a1a-a697-81b8252c856b",
"DeletedDates": [
"2026-08-20T12:00:30Z",
"2026-08-20T12:00:30Z"
],
"ClearedDates": [
"2026-08-20T12:00:30Z",
"2026-08-20T12:00:30Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-20T12:00:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-20T12:00:30Z",
"CreateDate": "2026-08-20T12:00:30Z",
"OccurTime": "2026-08-20T12:00:30Z",
"OccurEndTime": "2026-08-20T12:00:30Z",
"StartTime": "2026-08-20T12:00:30Z",
"EndTime": "2026-08-20T12:00:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6bf53701-7796-4aa2-a816-17784fa6449e",
"c56ca37e-9a3b-42a6-b72d-0ada8504b828"
],
"Companies": [
"d6925a71-d5a2-4eda-9eb4-d539be5d30c3",
"6dad2fb6-b33b-4485-83b1-4f7e62d0a2f5"
],
"Groups": [
"a158655e-f9d7-49e3-9976-7d181b7b0415",
"6c903615-4d61-4ba7-be3e-90623950bd0e"
],
"Opportunities": [
"0c4d0fa9-9601-4c52-b35c-8f73ea828d8d",
"c5802926-3879-48ca-9e42-f2d402d0b0a7"
]
}
}
]