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": "e42ab386-714d-473e-92b1-dec6c1b729d1",
"SeriesId": "9aba725b-f20b-46dd-8284-c1f9b800593c",
"AccessorID": "e7f97b26-3417-41c9-b23c-dec7b91a17dc",
"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": "1050855a-42da-45c3-aa30-ba1086456d48",
"ScheduledByID": "ab637586-8f16-4b9b-adcf-014194f69250",
"DeletedDates": [
"2026-08-28T07:14:35Z",
"2026-08-28T07:14:35Z"
],
"ClearedDates": [
"2026-08-28T07:14:35Z",
"2026-08-28T07:14:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-28T07:14:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-28T07:14:35Z",
"CreateDate": "2026-08-28T07:14:35Z",
"OccurTime": "2026-08-28T07:14:35Z",
"OccurEndTime": "2026-08-28T07:14:35Z",
"StartTime": "2026-08-28T07:14:35Z",
"EndTime": "2026-08-28T07:14:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b8c490b3-ab34-465c-832f-6ddd9d665909",
"615ad7f2-1783-4ffb-9fad-55a0697997ec"
],
"Companies": [
"df6aa05c-95b9-45a6-8961-67fd1c5dc818",
"36edc68f-6fa0-4b2d-833a-bb8c85187b15"
],
"Groups": [
"c9ef0524-5939-49f2-a51d-0e2c3ef09d14",
"768bafdc-7430-4eed-a4eb-5f14b5bc171f"
],
"Opportunities": [
"65dca288-55c4-4d35-9112-f0be76868c5d",
"2bf10f73-c1b0-4741-be10-f7aab7ffcea9"
]
}
},
{
"Id": "e42ab386-714d-473e-92b1-dec6c1b729d1",
"SeriesId": "9aba725b-f20b-46dd-8284-c1f9b800593c",
"AccessorID": "e7f97b26-3417-41c9-b23c-dec7b91a17dc",
"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": "1050855a-42da-45c3-aa30-ba1086456d48",
"ScheduledByID": "ab637586-8f16-4b9b-adcf-014194f69250",
"DeletedDates": [
"2026-08-28T07:14:35Z",
"2026-08-28T07:14:35Z"
],
"ClearedDates": [
"2026-08-28T07:14:35Z",
"2026-08-28T07:14:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-28T07:14:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-28T07:14:35Z",
"CreateDate": "2026-08-28T07:14:35Z",
"OccurTime": "2026-08-28T07:14:35Z",
"OccurEndTime": "2026-08-28T07:14:35Z",
"StartTime": "2026-08-28T07:14:35Z",
"EndTime": "2026-08-28T07:14:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b8c490b3-ab34-465c-832f-6ddd9d665909",
"615ad7f2-1783-4ffb-9fad-55a0697997ec"
],
"Companies": [
"df6aa05c-95b9-45a6-8961-67fd1c5dc818",
"36edc68f-6fa0-4b2d-833a-bb8c85187b15"
],
"Groups": [
"c9ef0524-5939-49f2-a51d-0e2c3ef09d14",
"768bafdc-7430-4eed-a4eb-5f14b5bc171f"
],
"Opportunities": [
"65dca288-55c4-4d35-9112-f0be76868c5d",
"2bf10f73-c1b0-4741-be10-f7aab7ffcea9"
]
}
}
]