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": "ca2f92f6-5280-453d-82e7-622d6b833743",
"SeriesId": "29fdd8fd-a90e-4458-a2b1-19e16a05df9c",
"AccessorID": "95736ee3-92fc-428c-8a60-5b5b21c0537a",
"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": "2fa9d2c2-1007-4c97-8ee8-b22998e1a486",
"ScheduledByID": "25c7de8b-4b2e-4c1a-ba74-a446ace66694",
"DeletedDates": [
"2026-04-24T04:04:59Z",
"2026-04-24T04:04:59Z"
],
"ClearedDates": [
"2026-04-24T04:04:59Z",
"2026-04-24T04:04:59Z"
],
"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-24T04:04:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-24T04:04:59Z",
"CreateDate": "2026-04-24T04:04:59Z",
"OccurTime": "2026-04-24T04:04:59Z",
"OccurEndTime": "2026-04-24T04:04:59Z",
"StartTime": "2026-04-24T04:04:59Z",
"EndTime": "2026-04-24T04:04:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d01ff818-1020-4f4a-9abe-c0c90c6b2289",
"89fb35ce-0563-439f-84fe-d8e3b4706a04"
],
"Companies": [
"f69634d3-6f3c-4bca-82b2-42cfacdfa8e3",
"600794ad-7594-4d56-ae29-bdec1dbbf4e1"
],
"Groups": [
"727103a4-d5fe-4d40-bbe8-1e9648a45ee7",
"446426b4-5bef-4d5d-8492-01a62d40731d"
],
"Opportunities": [
"88be9111-5566-404a-b11b-145c774d6959",
"4562d338-0cc3-4dd4-93b2-bfcab10c511b"
]
}
},
{
"Id": "ca2f92f6-5280-453d-82e7-622d6b833743",
"SeriesId": "29fdd8fd-a90e-4458-a2b1-19e16a05df9c",
"AccessorID": "95736ee3-92fc-428c-8a60-5b5b21c0537a",
"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": "2fa9d2c2-1007-4c97-8ee8-b22998e1a486",
"ScheduledByID": "25c7de8b-4b2e-4c1a-ba74-a446ace66694",
"DeletedDates": [
"2026-04-24T04:04:59Z",
"2026-04-24T04:04:59Z"
],
"ClearedDates": [
"2026-04-24T04:04:59Z",
"2026-04-24T04:04:59Z"
],
"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-24T04:04:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-24T04:04:59Z",
"CreateDate": "2026-04-24T04:04:59Z",
"OccurTime": "2026-04-24T04:04:59Z",
"OccurEndTime": "2026-04-24T04:04:59Z",
"StartTime": "2026-04-24T04:04:59Z",
"EndTime": "2026-04-24T04:04:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d01ff818-1020-4f4a-9abe-c0c90c6b2289",
"89fb35ce-0563-439f-84fe-d8e3b4706a04"
],
"Companies": [
"f69634d3-6f3c-4bca-82b2-42cfacdfa8e3",
"600794ad-7594-4d56-ae29-bdec1dbbf4e1"
],
"Groups": [
"727103a4-d5fe-4d40-bbe8-1e9648a45ee7",
"446426b4-5bef-4d5d-8492-01a62d40731d"
],
"Opportunities": [
"88be9111-5566-404a-b11b-145c774d6959",
"4562d338-0cc3-4dd4-93b2-bfcab10c511b"
]
}
}
]