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": "5deb643a-02d2-4c5c-853f-0776908e86cf",
"SeriesId": "ba8287b9-1cda-411a-a0f7-51392128ed48",
"AccessorID": "f5455fe5-f4c7-43d6-9a7c-03f012debf28",
"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": "27947a04-050f-4a8b-854c-526592642e3c",
"ScheduledByID": "5159415a-2132-4dec-94d8-a7d934c9021f",
"DeletedDates": [
"2026-10-27T19:43:50Z",
"2026-10-27T19:43:50Z"
],
"ClearedDates": [
"2026-10-27T19:43:50Z",
"2026-10-27T19:43:50Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-27T19:43:50Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-27T19:43:50Z",
"CreateDate": "2026-10-27T19:43:50Z",
"OccurTime": "2026-10-27T19:43:50Z",
"OccurEndTime": "2026-10-27T19:43:50Z",
"StartTime": "2026-10-27T19:43:50Z",
"EndTime": "2026-10-27T19:43:50Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8f4dfd8e-12ac-4c9f-8684-6bf6b649fee8",
"b921b068-ca79-4530-83ac-c5f904274cab"
],
"Companies": [
"0829b273-774a-4a90-a98b-a928c595c1ca",
"4514c87b-9784-43e9-a576-6bfa2be24353"
],
"Groups": [
"d0cfb10a-23bf-4dc4-a246-e29fda7efca1",
"dd896536-5b84-44b6-a117-25a6094cca28"
],
"Opportunities": [
"513eb733-a58a-4897-be1f-8ccf35da19a1",
"f4a609e5-3204-441d-9f2b-d7a6180ef448"
]
}
},
{
"Id": "5deb643a-02d2-4c5c-853f-0776908e86cf",
"SeriesId": "ba8287b9-1cda-411a-a0f7-51392128ed48",
"AccessorID": "f5455fe5-f4c7-43d6-9a7c-03f012debf28",
"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": "27947a04-050f-4a8b-854c-526592642e3c",
"ScheduledByID": "5159415a-2132-4dec-94d8-a7d934c9021f",
"DeletedDates": [
"2026-10-27T19:43:50Z",
"2026-10-27T19:43:50Z"
],
"ClearedDates": [
"2026-10-27T19:43:50Z",
"2026-10-27T19:43:50Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-27T19:43:50Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-27T19:43:50Z",
"CreateDate": "2026-10-27T19:43:50Z",
"OccurTime": "2026-10-27T19:43:50Z",
"OccurEndTime": "2026-10-27T19:43:50Z",
"StartTime": "2026-10-27T19:43:50Z",
"EndTime": "2026-10-27T19:43:50Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"8f4dfd8e-12ac-4c9f-8684-6bf6b649fee8",
"b921b068-ca79-4530-83ac-c5f904274cab"
],
"Companies": [
"0829b273-774a-4a90-a98b-a928c595c1ca",
"4514c87b-9784-43e9-a576-6bfa2be24353"
],
"Groups": [
"d0cfb10a-23bf-4dc4-a246-e29fda7efca1",
"dd896536-5b84-44b6-a117-25a6094cca28"
],
"Opportunities": [
"513eb733-a58a-4897-be1f-8ccf35da19a1",
"f4a609e5-3204-441d-9f2b-d7a6180ef448"
]
}
}
]