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": "9ef9f3be-c32f-4537-9075-c037631cf302",
"SeriesId": "22e0bbca-2cbb-4bef-bbfc-76e8aa7ee3c6",
"AccessorID": "09f7e856-d223-405d-bd77-3167bd386dc8",
"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": "dc132698-4565-45e1-bc88-767dc7a2bae7",
"ScheduledByID": "f0ec2f7e-d6ef-4939-a5c1-d3628e416122",
"DeletedDates": [
"2026-04-23T01:50:17Z",
"2026-04-23T01:50:17Z"
],
"ClearedDates": [
"2026-04-23T01:50:17Z",
"2026-04-23T01:50:17Z"
],
"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-23T01:50:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-23T01:50:17Z",
"CreateDate": "2026-04-23T01:50:17Z",
"OccurTime": "2026-04-23T01:50:17Z",
"OccurEndTime": "2026-04-23T01:50:17Z",
"StartTime": "2026-04-23T01:50:17Z",
"EndTime": "2026-04-23T01:50:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"16d965be-649a-495e-991e-941968c251ac",
"715cfe82-3c98-4d0a-8754-9ca23e40e39e"
],
"Companies": [
"9d80cf19-b748-4116-a17a-15fff35e248a",
"e000f79a-c139-45f2-8123-a90ab3facd30"
],
"Groups": [
"8bf88d87-418a-42c6-95d7-f90a749738fa",
"39a21814-330b-4501-80ae-a59f4d83d7f9"
],
"Opportunities": [
"835dd36f-97d2-4e33-93e1-3c36e320da00",
"b3b7820b-c7f3-4ead-956f-5e07ebeb85fe"
]
}
},
{
"Id": "9ef9f3be-c32f-4537-9075-c037631cf302",
"SeriesId": "22e0bbca-2cbb-4bef-bbfc-76e8aa7ee3c6",
"AccessorID": "09f7e856-d223-405d-bd77-3167bd386dc8",
"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": "dc132698-4565-45e1-bc88-767dc7a2bae7",
"ScheduledByID": "f0ec2f7e-d6ef-4939-a5c1-d3628e416122",
"DeletedDates": [
"2026-04-23T01:50:17Z",
"2026-04-23T01:50:17Z"
],
"ClearedDates": [
"2026-04-23T01:50:17Z",
"2026-04-23T01:50:17Z"
],
"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-23T01:50:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-23T01:50:17Z",
"CreateDate": "2026-04-23T01:50:17Z",
"OccurTime": "2026-04-23T01:50:17Z",
"OccurEndTime": "2026-04-23T01:50:17Z",
"StartTime": "2026-04-23T01:50:17Z",
"EndTime": "2026-04-23T01:50:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"16d965be-649a-495e-991e-941968c251ac",
"715cfe82-3c98-4d0a-8754-9ca23e40e39e"
],
"Companies": [
"9d80cf19-b748-4116-a17a-15fff35e248a",
"e000f79a-c139-45f2-8123-a90ab3facd30"
],
"Groups": [
"8bf88d87-418a-42c6-95d7-f90a749738fa",
"39a21814-330b-4501-80ae-a59f4d83d7f9"
],
"Opportunities": [
"835dd36f-97d2-4e33-93e1-3c36e320da00",
"b3b7820b-c7f3-4ead-956f-5e07ebeb85fe"
]
}
}
]