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": "730acd85-fc28-4721-874e-c5b318a5b41b",
"SeriesId": "b8fdece2-44d5-483c-a8f1-5ab0e8e6a21a",
"AccessorID": "8fabc003-372a-4230-a4b7-7ce7f83685a7",
"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": "90927655-6229-47f8-af3b-b908dab6204a",
"ScheduledByID": "cd1ff838-86a9-4a0d-9b70-b31513ad335b",
"DeletedDates": [
"2025-12-21T17:48:55Z",
"2025-12-21T17:48:55Z"
],
"ClearedDates": [
"2025-12-21T17:48:55Z",
"2025-12-21T17:48:55Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-21T17:48:55Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-21T17:48:55Z",
"CreateDate": "2025-12-21T17:48:55Z",
"OccurTime": "2025-12-21T17:48:55Z",
"OccurEndTime": "2025-12-21T17:48:55Z",
"StartTime": "2025-12-21T17:48:55Z",
"EndTime": "2025-12-21T17:48:55Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f143b112-a7f2-42ff-8b7c-466359bd5251",
"40786ab3-2b6d-4811-93e8-f2a937c61f97"
],
"Companies": [
"508825cf-38f7-4500-a5eb-0d0d2220305f",
"62b930eb-63db-4811-bcaf-6b1648cd1b72"
],
"Groups": [
"4fe0c355-05c4-4871-b7b9-cec58eb2b6b8",
"44478e3d-7e17-4544-9750-51a171251e57"
],
"Opportunities": [
"39f09921-ea27-43c6-834b-3c44bd6de040",
"7d3ce80e-f048-402c-8338-a61f62746d56"
]
}
},
{
"Id": "730acd85-fc28-4721-874e-c5b318a5b41b",
"SeriesId": "b8fdece2-44d5-483c-a8f1-5ab0e8e6a21a",
"AccessorID": "8fabc003-372a-4230-a4b7-7ce7f83685a7",
"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": "90927655-6229-47f8-af3b-b908dab6204a",
"ScheduledByID": "cd1ff838-86a9-4a0d-9b70-b31513ad335b",
"DeletedDates": [
"2025-12-21T17:48:55Z",
"2025-12-21T17:48:55Z"
],
"ClearedDates": [
"2025-12-21T17:48:55Z",
"2025-12-21T17:48:55Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-21T17:48:55Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-21T17:48:55Z",
"CreateDate": "2025-12-21T17:48:55Z",
"OccurTime": "2025-12-21T17:48:55Z",
"OccurEndTime": "2025-12-21T17:48:55Z",
"StartTime": "2025-12-21T17:48:55Z",
"EndTime": "2025-12-21T17:48:55Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f143b112-a7f2-42ff-8b7c-466359bd5251",
"40786ab3-2b6d-4811-93e8-f2a937c61f97"
],
"Companies": [
"508825cf-38f7-4500-a5eb-0d0d2220305f",
"62b930eb-63db-4811-bcaf-6b1648cd1b72"
],
"Groups": [
"4fe0c355-05c4-4871-b7b9-cec58eb2b6b8",
"44478e3d-7e17-4544-9750-51a171251e57"
],
"Opportunities": [
"39f09921-ea27-43c6-834b-3c44bd6de040",
"7d3ce80e-f048-402c-8338-a61f62746d56"
]
}
}
]