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": "fddf078d-e84e-4b1d-ac37-27828d06125d",
"SeriesId": "d9fe080d-0880-4e31-b495-15944632d9fc",
"AccessorID": "19f3d7f9-1788-46db-a657-6c75dc451a10",
"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": "9a55399a-fa1c-479e-ae59-0eb746f7d78c",
"ScheduledByID": "566f145d-20f9-47a7-b91a-42445b8454c3",
"DeletedDates": [
"2026-04-13T23:16:17Z",
"2026-04-13T23:16:17Z"
],
"ClearedDates": [
"2026-04-13T23:16:17Z",
"2026-04-13T23:16:17Z"
],
"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-13T23:16:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-13T23:16:17Z",
"CreateDate": "2026-04-13T23:16:17Z",
"OccurTime": "2026-04-13T23:16:17Z",
"OccurEndTime": "2026-04-13T23:16:17Z",
"StartTime": "2026-04-13T23:16:17Z",
"EndTime": "2026-04-13T23:16:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c5d20f8a-37d5-435a-a814-6116f4d3273d",
"2275fec7-fa0a-4dee-8c76-18e1e9f37c3e"
],
"Companies": [
"c501b36b-0a8c-4978-82c8-51ea6edc6e6e",
"55748fdb-59ec-4819-9255-df3c184997d7"
],
"Groups": [
"a3488e8a-44fc-4574-b970-039f8701ad3c",
"ed78d31a-847e-49b3-9a31-4d17cc7ea93e"
],
"Opportunities": [
"d4519435-7ee9-47a0-a3a9-6ada966e3986",
"36f0783c-bc83-4545-8f22-018c6ceeeed1"
]
}
},
{
"Id": "fddf078d-e84e-4b1d-ac37-27828d06125d",
"SeriesId": "d9fe080d-0880-4e31-b495-15944632d9fc",
"AccessorID": "19f3d7f9-1788-46db-a657-6c75dc451a10",
"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": "9a55399a-fa1c-479e-ae59-0eb746f7d78c",
"ScheduledByID": "566f145d-20f9-47a7-b91a-42445b8454c3",
"DeletedDates": [
"2026-04-13T23:16:17Z",
"2026-04-13T23:16:17Z"
],
"ClearedDates": [
"2026-04-13T23:16:17Z",
"2026-04-13T23:16:17Z"
],
"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-13T23:16:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-13T23:16:17Z",
"CreateDate": "2026-04-13T23:16:17Z",
"OccurTime": "2026-04-13T23:16:17Z",
"OccurEndTime": "2026-04-13T23:16:17Z",
"StartTime": "2026-04-13T23:16:17Z",
"EndTime": "2026-04-13T23:16:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c5d20f8a-37d5-435a-a814-6116f4d3273d",
"2275fec7-fa0a-4dee-8c76-18e1e9f37c3e"
],
"Companies": [
"c501b36b-0a8c-4978-82c8-51ea6edc6e6e",
"55748fdb-59ec-4819-9255-df3c184997d7"
],
"Groups": [
"a3488e8a-44fc-4574-b970-039f8701ad3c",
"ed78d31a-847e-49b3-9a31-4d17cc7ea93e"
],
"Opportunities": [
"d4519435-7ee9-47a0-a3a9-6ada966e3986",
"36f0783c-bc83-4545-8f22-018c6ceeeed1"
]
}
}
]