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": "b5ed705b-48e4-4903-befb-69d213c4e9e9",
"SeriesId": "44ab9453-e006-4bd4-8e22-1a4fc01e4efa",
"AccessorID": "d784eacc-3e1f-4887-bae8-46a811ad92f0",
"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": "9ed1e278-720e-4930-94a4-b18a860a9c34",
"ScheduledByID": "97abcc22-5e0e-48d1-af45-0614bfc49b0d",
"DeletedDates": [
"2026-10-12T10:11:25Z",
"2026-10-12T10:11:25Z"
],
"ClearedDates": [
"2026-10-12T10:11:25Z",
"2026-10-12T10:11: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-12T10:11:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-12T10:11:25Z",
"CreateDate": "2026-10-12T10:11:25Z",
"OccurTime": "2026-10-12T10:11:25Z",
"OccurEndTime": "2026-10-12T10:11:25Z",
"StartTime": "2026-10-12T10:11:25Z",
"EndTime": "2026-10-12T10:11:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9f9e4290-2b79-43a6-8c88-815e8fa2d248",
"edf75994-09e3-4a26-a400-475ad4a91e7c"
],
"Companies": [
"01ad1ea6-f9bc-448f-9c3c-298d7f860c0f",
"bd45477e-8a48-415f-9c44-75ab0ae43924"
],
"Groups": [
"bec0b739-2fd6-4390-8822-6d5862cdef3e",
"05fc4404-4eca-4132-ad9e-40479ebcf694"
],
"Opportunities": [
"52fdb128-fa0e-490b-b418-33fd6a3d2c40",
"82c16751-5d9f-42c6-bf6a-d80e2ece32db"
]
}
},
{
"Id": "b5ed705b-48e4-4903-befb-69d213c4e9e9",
"SeriesId": "44ab9453-e006-4bd4-8e22-1a4fc01e4efa",
"AccessorID": "d784eacc-3e1f-4887-bae8-46a811ad92f0",
"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": "9ed1e278-720e-4930-94a4-b18a860a9c34",
"ScheduledByID": "97abcc22-5e0e-48d1-af45-0614bfc49b0d",
"DeletedDates": [
"2026-10-12T10:11:25Z",
"2026-10-12T10:11:25Z"
],
"ClearedDates": [
"2026-10-12T10:11:25Z",
"2026-10-12T10:11: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-12T10:11:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-12T10:11:25Z",
"CreateDate": "2026-10-12T10:11:25Z",
"OccurTime": "2026-10-12T10:11:25Z",
"OccurEndTime": "2026-10-12T10:11:25Z",
"StartTime": "2026-10-12T10:11:25Z",
"EndTime": "2026-10-12T10:11:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9f9e4290-2b79-43a6-8c88-815e8fa2d248",
"edf75994-09e3-4a26-a400-475ad4a91e7c"
],
"Companies": [
"01ad1ea6-f9bc-448f-9c3c-298d7f860c0f",
"bd45477e-8a48-415f-9c44-75ab0ae43924"
],
"Groups": [
"bec0b739-2fd6-4390-8822-6d5862cdef3e",
"05fc4404-4eca-4132-ad9e-40479ebcf694"
],
"Opportunities": [
"52fdb128-fa0e-490b-b418-33fd6a3d2c40",
"82c16751-5d9f-42c6-bf6a-d80e2ece32db"
]
}
}
]