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": "f91371f1-a5e3-4c73-be76-34290b20d4c0",
"SeriesId": "9bdeb1c9-1446-4e04-8954-81392476008e",
"AccessorID": "e3ab1c52-fea0-4e7d-a06e-c598299c373e",
"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": "2e3e5f34-7bae-41e6-8069-1c80862dcf41",
"ScheduledByID": "c755ace3-d232-4af3-8a3a-9572d9223bbc",
"DeletedDates": [
"2026-09-05T13:32:21Z",
"2026-09-05T13:32:21Z"
],
"ClearedDates": [
"2026-09-05T13:32:21Z",
"2026-09-05T13:32:21Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-05T13:32:21Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-05T13:32:21Z",
"CreateDate": "2026-09-05T13:32:21Z",
"OccurTime": "2026-09-05T13:32:21Z",
"OccurEndTime": "2026-09-05T13:32:21Z",
"StartTime": "2026-09-05T13:32:21Z",
"EndTime": "2026-09-05T13:32:21Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"170d01f3-b906-4590-9594-d975bb55010d",
"ab042aeb-2e48-4c8f-a5fa-da0c5e12d845"
],
"Companies": [
"42436e22-3a7f-4e67-ba25-b351cd97256b",
"7e146142-5d44-4598-af14-10ca20e40699"
],
"Groups": [
"43e50d23-2a6e-4b8f-80ca-dd6c060523a0",
"fd76b036-3d58-4a53-b02b-5880377e43de"
],
"Opportunities": [
"f6b04367-946b-46f4-9225-cef4180cd2d2",
"4e0c44f2-973a-4656-bade-c2e6f5fdd41a"
]
}
},
{
"Id": "f91371f1-a5e3-4c73-be76-34290b20d4c0",
"SeriesId": "9bdeb1c9-1446-4e04-8954-81392476008e",
"AccessorID": "e3ab1c52-fea0-4e7d-a06e-c598299c373e",
"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": "2e3e5f34-7bae-41e6-8069-1c80862dcf41",
"ScheduledByID": "c755ace3-d232-4af3-8a3a-9572d9223bbc",
"DeletedDates": [
"2026-09-05T13:32:21Z",
"2026-09-05T13:32:21Z"
],
"ClearedDates": [
"2026-09-05T13:32:21Z",
"2026-09-05T13:32:21Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-05T13:32:21Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-05T13:32:21Z",
"CreateDate": "2026-09-05T13:32:21Z",
"OccurTime": "2026-09-05T13:32:21Z",
"OccurEndTime": "2026-09-05T13:32:21Z",
"StartTime": "2026-09-05T13:32:21Z",
"EndTime": "2026-09-05T13:32:21Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"170d01f3-b906-4590-9594-d975bb55010d",
"ab042aeb-2e48-4c8f-a5fa-da0c5e12d845"
],
"Companies": [
"42436e22-3a7f-4e67-ba25-b351cd97256b",
"7e146142-5d44-4598-af14-10ca20e40699"
],
"Groups": [
"43e50d23-2a6e-4b8f-80ca-dd6c060523a0",
"fd76b036-3d58-4a53-b02b-5880377e43de"
],
"Opportunities": [
"f6b04367-946b-46f4-9225-cef4180cd2d2",
"4e0c44f2-973a-4656-bade-c2e6f5fdd41a"
]
}
}
]