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": "27009a92-3bf6-49fb-ac43-648a464fcdf5",
"SeriesId": "d60cb1b7-1507-4c80-bd03-fb89c5bbcdd0",
"AccessorID": "5ce6c9aa-8e95-4082-8258-09a25a75b8e9",
"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": "7f12b564-6eed-4780-b77a-7897f6786ada",
"ScheduledByID": "b5704154-4d33-43f9-9e6a-9cf33a7ee772",
"DeletedDates": [
"2026-10-09T06:11:11Z",
"2026-10-09T06:11:11Z"
],
"ClearedDates": [
"2026-10-09T06:11:11Z",
"2026-10-09T06:11:11Z"
],
"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-09T06:11:11Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-09T06:11:11Z",
"CreateDate": "2026-10-09T06:11:11Z",
"OccurTime": "2026-10-09T06:11:11Z",
"OccurEndTime": "2026-10-09T06:11:11Z",
"StartTime": "2026-10-09T06:11:11Z",
"EndTime": "2026-10-09T06:11:11Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7f66a12e-d7d8-4236-ba3d-39c9bbde0e78",
"139e9bb7-952c-4fd9-a3c6-013cddb9a294"
],
"Companies": [
"c80d5f3e-a6c2-4c46-ac5e-c32d6a40fc5b",
"1531e4ee-ba4a-4566-a802-8b1e3626cc3c"
],
"Groups": [
"47741443-cdfe-4338-89d5-4c15b3546362",
"b85481d7-570e-43bc-a7c5-d79fef5d35d7"
],
"Opportunities": [
"e5fb8f63-d815-49b4-ac4d-175634c240ae",
"86354a87-4ddb-496e-b47f-5cb784082345"
]
}
},
{
"Id": "27009a92-3bf6-49fb-ac43-648a464fcdf5",
"SeriesId": "d60cb1b7-1507-4c80-bd03-fb89c5bbcdd0",
"AccessorID": "5ce6c9aa-8e95-4082-8258-09a25a75b8e9",
"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": "7f12b564-6eed-4780-b77a-7897f6786ada",
"ScheduledByID": "b5704154-4d33-43f9-9e6a-9cf33a7ee772",
"DeletedDates": [
"2026-10-09T06:11:11Z",
"2026-10-09T06:11:11Z"
],
"ClearedDates": [
"2026-10-09T06:11:11Z",
"2026-10-09T06:11:11Z"
],
"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-09T06:11:11Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-09T06:11:11Z",
"CreateDate": "2026-10-09T06:11:11Z",
"OccurTime": "2026-10-09T06:11:11Z",
"OccurEndTime": "2026-10-09T06:11:11Z",
"StartTime": "2026-10-09T06:11:11Z",
"EndTime": "2026-10-09T06:11:11Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7f66a12e-d7d8-4236-ba3d-39c9bbde0e78",
"139e9bb7-952c-4fd9-a3c6-013cddb9a294"
],
"Companies": [
"c80d5f3e-a6c2-4c46-ac5e-c32d6a40fc5b",
"1531e4ee-ba4a-4566-a802-8b1e3626cc3c"
],
"Groups": [
"47741443-cdfe-4338-89d5-4c15b3546362",
"b85481d7-570e-43bc-a7c5-d79fef5d35d7"
],
"Opportunities": [
"e5fb8f63-d815-49b4-ac4d-175634c240ae",
"86354a87-4ddb-496e-b47f-5cb784082345"
]
}
}
]