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": "da1c2e3d-2931-4000-b7e7-9e587103c585",
"SeriesId": "8d071f71-523f-414a-a294-0dfb0f1320c2",
"AccessorID": "ac7911f7-5323-4aff-b836-59fd59ef0486",
"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": "d69bcb51-7ca5-4664-99b0-c461bade440d",
"ScheduledByID": "cfa3b3b3-7f19-43ae-9c3f-59b924dd9ffa",
"DeletedDates": [
"2026-05-14T11:23:43Z",
"2026-05-14T11:23:43Z"
],
"ClearedDates": [
"2026-05-14T11:23:43Z",
"2026-05-14T11:23:43Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-14T11:23:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-14T11:23:43Z",
"CreateDate": "2026-05-14T11:23:43Z",
"OccurTime": "2026-05-14T11:23:43Z",
"OccurEndTime": "2026-05-14T11:23:43Z",
"StartTime": "2026-05-14T11:23:43Z",
"EndTime": "2026-05-14T11:23:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"24872d15-0930-4370-acd5-10c18ad3d93f",
"9e15cb9a-14eb-4c00-81bb-9c9fb383600e"
],
"Companies": [
"c8d80f34-f727-467c-b982-1e65aa63d119",
"b4157115-a05c-4d67-97da-48d94e3bff4c"
],
"Groups": [
"a676cb04-b494-4a5f-b238-ed18598209b4",
"518c2200-15dc-4dab-9fb2-63f47b3041e9"
],
"Opportunities": [
"4aae4bbe-def2-4118-a3e6-643b0a8c427d",
"ef137ae0-1e9b-420b-b515-eb34541abbf4"
]
}
},
{
"Id": "da1c2e3d-2931-4000-b7e7-9e587103c585",
"SeriesId": "8d071f71-523f-414a-a294-0dfb0f1320c2",
"AccessorID": "ac7911f7-5323-4aff-b836-59fd59ef0486",
"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": "d69bcb51-7ca5-4664-99b0-c461bade440d",
"ScheduledByID": "cfa3b3b3-7f19-43ae-9c3f-59b924dd9ffa",
"DeletedDates": [
"2026-05-14T11:23:43Z",
"2026-05-14T11:23:43Z"
],
"ClearedDates": [
"2026-05-14T11:23:43Z",
"2026-05-14T11:23:43Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-14T11:23:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-14T11:23:43Z",
"CreateDate": "2026-05-14T11:23:43Z",
"OccurTime": "2026-05-14T11:23:43Z",
"OccurEndTime": "2026-05-14T11:23:43Z",
"StartTime": "2026-05-14T11:23:43Z",
"EndTime": "2026-05-14T11:23:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"24872d15-0930-4370-acd5-10c18ad3d93f",
"9e15cb9a-14eb-4c00-81bb-9c9fb383600e"
],
"Companies": [
"c8d80f34-f727-467c-b982-1e65aa63d119",
"b4157115-a05c-4d67-97da-48d94e3bff4c"
],
"Groups": [
"a676cb04-b494-4a5f-b238-ed18598209b4",
"518c2200-15dc-4dab-9fb2-63f47b3041e9"
],
"Opportunities": [
"4aae4bbe-def2-4118-a3e6-643b0a8c427d",
"ef137ae0-1e9b-420b-b515-eb34541abbf4"
]
}
}
]