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": "bc9dffcf-b9a1-4feb-87fc-462021bcdc2e",
"SeriesId": "152756ed-696e-4ab5-a006-338efa3178bf",
"AccessorID": "64f5d693-6568-4b9b-9945-6ec6249cf01c",
"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": "6148c000-2407-491b-bf5c-6c95f74529bd",
"ScheduledByID": "9df92464-980c-4137-ba80-cdbf4c06dbc3",
"DeletedDates": [
"2026-04-21T12:08:02Z",
"2026-04-21T12:08:02Z"
],
"ClearedDates": [
"2026-04-21T12:08:02Z",
"2026-04-21T12:08:02Z"
],
"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-21T12:08:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-21T12:08:02Z",
"CreateDate": "2026-04-21T12:08:02Z",
"OccurTime": "2026-04-21T12:08:02Z",
"OccurEndTime": "2026-04-21T12:08:02Z",
"StartTime": "2026-04-21T12:08:02Z",
"EndTime": "2026-04-21T12:08:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"25044f28-24dd-4b47-940d-1c3aa50e0f47",
"cbd57719-10cf-4832-8527-064648d1a638"
],
"Companies": [
"b7d91f01-145c-4ee7-8c2d-cebe01acc8a7",
"2a5ea53c-07c3-409c-aba4-b26bee89ec97"
],
"Groups": [
"891db69e-21fa-4307-bc39-4c9287374c1a",
"0c215cc0-4fdb-483d-8d81-f8ce44a58037"
],
"Opportunities": [
"6d51cedd-4062-4922-b453-87e00cfb1438",
"27b0bd06-7745-444b-91d8-7fd357b75de1"
]
}
},
{
"Id": "bc9dffcf-b9a1-4feb-87fc-462021bcdc2e",
"SeriesId": "152756ed-696e-4ab5-a006-338efa3178bf",
"AccessorID": "64f5d693-6568-4b9b-9945-6ec6249cf01c",
"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": "6148c000-2407-491b-bf5c-6c95f74529bd",
"ScheduledByID": "9df92464-980c-4137-ba80-cdbf4c06dbc3",
"DeletedDates": [
"2026-04-21T12:08:02Z",
"2026-04-21T12:08:02Z"
],
"ClearedDates": [
"2026-04-21T12:08:02Z",
"2026-04-21T12:08:02Z"
],
"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-21T12:08:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-21T12:08:02Z",
"CreateDate": "2026-04-21T12:08:02Z",
"OccurTime": "2026-04-21T12:08:02Z",
"OccurEndTime": "2026-04-21T12:08:02Z",
"StartTime": "2026-04-21T12:08:02Z",
"EndTime": "2026-04-21T12:08:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"25044f28-24dd-4b47-940d-1c3aa50e0f47",
"cbd57719-10cf-4832-8527-064648d1a638"
],
"Companies": [
"b7d91f01-145c-4ee7-8c2d-cebe01acc8a7",
"2a5ea53c-07c3-409c-aba4-b26bee89ec97"
],
"Groups": [
"891db69e-21fa-4307-bc39-4c9287374c1a",
"0c215cc0-4fdb-483d-8d81-f8ce44a58037"
],
"Opportunities": [
"6d51cedd-4062-4922-b453-87e00cfb1438",
"27b0bd06-7745-444b-91d8-7fd357b75de1"
]
}
}
]