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": "179be7a2-42f5-434a-a238-155f5a84a2d0",
"SeriesId": "b35dba78-0a34-4f2a-9139-a95c992fdc16",
"AccessorID": "20a47b3a-86d5-40d4-a275-929c95490d59",
"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": "c17d85a2-16be-4332-a0db-029dee3524ba",
"ScheduledByID": "bbcef683-a622-4df7-b639-a6e28088c7cd",
"DeletedDates": [
"2026-06-22T11:51:19Z",
"2026-06-22T11:51:19Z"
],
"ClearedDates": [
"2026-06-22T11:51:19Z",
"2026-06-22T11:51:19Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-22T11:51:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-22T11:51:19Z",
"CreateDate": "2026-06-22T11:51:19Z",
"OccurTime": "2026-06-22T11:51:19Z",
"OccurEndTime": "2026-06-22T11:51:19Z",
"StartTime": "2026-06-22T11:51:19Z",
"EndTime": "2026-06-22T11:51:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8189543c-5838-45aa-a484-b605ec303b05",
"1632b19f-64e3-477f-9fb5-f06d0788ee63"
],
"Companies": [
"8bd91795-b3be-4819-a589-5c5c2030306d",
"fd996224-7801-4e4f-a53b-f92460eb3502"
],
"Groups": [
"03c03558-8d30-4130-b19a-40c96a207b6e",
"2711cb9e-fb24-4ada-82a6-a4e81a939840"
],
"Opportunities": [
"f65fdef3-3e1e-4722-9679-f60e0111732d",
"c2cbf0ca-85b3-4123-9b15-cd734d95db29"
]
}
},
{
"Id": "179be7a2-42f5-434a-a238-155f5a84a2d0",
"SeriesId": "b35dba78-0a34-4f2a-9139-a95c992fdc16",
"AccessorID": "20a47b3a-86d5-40d4-a275-929c95490d59",
"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": "c17d85a2-16be-4332-a0db-029dee3524ba",
"ScheduledByID": "bbcef683-a622-4df7-b639-a6e28088c7cd",
"DeletedDates": [
"2026-06-22T11:51:19Z",
"2026-06-22T11:51:19Z"
],
"ClearedDates": [
"2026-06-22T11:51:19Z",
"2026-06-22T11:51:19Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-22T11:51:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-22T11:51:19Z",
"CreateDate": "2026-06-22T11:51:19Z",
"OccurTime": "2026-06-22T11:51:19Z",
"OccurEndTime": "2026-06-22T11:51:19Z",
"StartTime": "2026-06-22T11:51:19Z",
"EndTime": "2026-06-22T11:51:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8189543c-5838-45aa-a484-b605ec303b05",
"1632b19f-64e3-477f-9fb5-f06d0788ee63"
],
"Companies": [
"8bd91795-b3be-4819-a589-5c5c2030306d",
"fd996224-7801-4e4f-a53b-f92460eb3502"
],
"Groups": [
"03c03558-8d30-4130-b19a-40c96a207b6e",
"2711cb9e-fb24-4ada-82a6-a4e81a939840"
],
"Opportunities": [
"f65fdef3-3e1e-4722-9679-f60e0111732d",
"c2cbf0ca-85b3-4123-9b15-cd734d95db29"
]
}
}
]