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": "74e0fcfe-37d3-4830-848f-ac35339cb284",
"SeriesId": "b3f669f3-c7d1-4d23-ac9c-1a851c3aa67c",
"AccessorID": "4717f025-1518-4ce6-8fba-833ae0472f4d",
"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": "5a92e16d-b449-463a-89b0-f4cde21557d5",
"ScheduledByID": "6a8a64c4-d93d-43bc-8367-0e40e5a1f075",
"DeletedDates": [
"2026-10-18T16:52:25Z",
"2026-10-18T16:52:25Z"
],
"ClearedDates": [
"2026-10-18T16:52:25Z",
"2026-10-18T16:52:25Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-18T16:52:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-18T16:52:25Z",
"CreateDate": "2026-10-18T16:52:25Z",
"OccurTime": "2026-10-18T16:52:25Z",
"OccurEndTime": "2026-10-18T16:52:25Z",
"StartTime": "2026-10-18T16:52:25Z",
"EndTime": "2026-10-18T16:52:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dd864319-5d72-49d8-8c4d-ebe7665d9f1f",
"697b9dec-2cb8-499b-be07-a810032ccba6"
],
"Companies": [
"8076c5cc-5273-4c1a-a24c-73c5bc5bea6b",
"668d3840-341b-4910-9824-93ce71d2ff3d"
],
"Groups": [
"80d7cafd-9592-40c6-8c1e-91feadd9cde1",
"62030d2b-c455-49ba-ad1c-a87806b893ad"
],
"Opportunities": [
"5dabf20d-cdf0-4e5e-a4ae-d06d85c3f64e",
"13a26932-f28c-47d1-9120-7cc86df7f937"
]
}
},
{
"Id": "74e0fcfe-37d3-4830-848f-ac35339cb284",
"SeriesId": "b3f669f3-c7d1-4d23-ac9c-1a851c3aa67c",
"AccessorID": "4717f025-1518-4ce6-8fba-833ae0472f4d",
"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": "5a92e16d-b449-463a-89b0-f4cde21557d5",
"ScheduledByID": "6a8a64c4-d93d-43bc-8367-0e40e5a1f075",
"DeletedDates": [
"2026-10-18T16:52:25Z",
"2026-10-18T16:52:25Z"
],
"ClearedDates": [
"2026-10-18T16:52:25Z",
"2026-10-18T16:52:25Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-18T16:52:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-18T16:52:25Z",
"CreateDate": "2026-10-18T16:52:25Z",
"OccurTime": "2026-10-18T16:52:25Z",
"OccurEndTime": "2026-10-18T16:52:25Z",
"StartTime": "2026-10-18T16:52:25Z",
"EndTime": "2026-10-18T16:52:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dd864319-5d72-49d8-8c4d-ebe7665d9f1f",
"697b9dec-2cb8-499b-be07-a810032ccba6"
],
"Companies": [
"8076c5cc-5273-4c1a-a24c-73c5bc5bea6b",
"668d3840-341b-4910-9824-93ce71d2ff3d"
],
"Groups": [
"80d7cafd-9592-40c6-8c1e-91feadd9cde1",
"62030d2b-c455-49ba-ad1c-a87806b893ad"
],
"Opportunities": [
"5dabf20d-cdf0-4e5e-a4ae-d06d85c3f64e",
"13a26932-f28c-47d1-9120-7cc86df7f937"
]
}
}
]