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": "b765a291-5d8a-4023-8a5b-57d5ace240f6",
"SeriesId": "ca7a254e-175e-4052-b50e-29acf951c423",
"AccessorID": "8887e6eb-dc81-4dca-84d0-86e0f03738e3",
"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": "a5280f46-d35e-43d4-96fc-238b13ba85a0",
"ScheduledByID": "ae7882bd-04e2-4f66-b1d5-294b6918fab5",
"DeletedDates": [
"2026-04-25T04:58:32Z",
"2026-04-25T04:58:32Z"
],
"ClearedDates": [
"2026-04-25T04:58:32Z",
"2026-04-25T04:58:32Z"
],
"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-25T04:58:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-25T04:58:32Z",
"CreateDate": "2026-04-25T04:58:32Z",
"OccurTime": "2026-04-25T04:58:32Z",
"OccurEndTime": "2026-04-25T04:58:32Z",
"StartTime": "2026-04-25T04:58:32Z",
"EndTime": "2026-04-25T04:58:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"512a7e1b-5c0d-4127-9192-7ba0f1e8ae3b",
"0cab0096-b1e4-4dab-a8b9-e74e2c9f9df9"
],
"Companies": [
"693b8cdb-93a9-48e2-a448-4ed0085e9b66",
"7aede49f-f5a8-4ffb-bd75-fa64c51fa349"
],
"Groups": [
"fa45f4c8-a745-4d77-a6c7-0c8f9e89c914",
"36a4ffd2-e468-4faf-9835-c12e69c79d5d"
],
"Opportunities": [
"ca276342-b266-4dce-b584-e243cee016a8",
"1c75886c-a99e-40ce-be6c-378d5b416e98"
]
}
},
{
"Id": "b765a291-5d8a-4023-8a5b-57d5ace240f6",
"SeriesId": "ca7a254e-175e-4052-b50e-29acf951c423",
"AccessorID": "8887e6eb-dc81-4dca-84d0-86e0f03738e3",
"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": "a5280f46-d35e-43d4-96fc-238b13ba85a0",
"ScheduledByID": "ae7882bd-04e2-4f66-b1d5-294b6918fab5",
"DeletedDates": [
"2026-04-25T04:58:32Z",
"2026-04-25T04:58:32Z"
],
"ClearedDates": [
"2026-04-25T04:58:32Z",
"2026-04-25T04:58:32Z"
],
"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-25T04:58:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-25T04:58:32Z",
"CreateDate": "2026-04-25T04:58:32Z",
"OccurTime": "2026-04-25T04:58:32Z",
"OccurEndTime": "2026-04-25T04:58:32Z",
"StartTime": "2026-04-25T04:58:32Z",
"EndTime": "2026-04-25T04:58:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"512a7e1b-5c0d-4127-9192-7ba0f1e8ae3b",
"0cab0096-b1e4-4dab-a8b9-e74e2c9f9df9"
],
"Companies": [
"693b8cdb-93a9-48e2-a448-4ed0085e9b66",
"7aede49f-f5a8-4ffb-bd75-fa64c51fa349"
],
"Groups": [
"fa45f4c8-a745-4d77-a6c7-0c8f9e89c914",
"36a4ffd2-e468-4faf-9835-c12e69c79d5d"
],
"Opportunities": [
"ca276342-b266-4dce-b584-e243cee016a8",
"1c75886c-a99e-40ce-be6c-378d5b416e98"
]
}
}
]