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": "ce806ab0-420d-4640-b341-42234c711ff5",
"SeriesId": "2b0fa8e2-018b-4c57-b38b-d078420d44bb",
"AccessorID": "1bd6318a-74f0-40b5-8479-ff34c4cb00ee",
"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": "305f7a2b-2d6a-4921-9dc3-80d6848b38aa",
"ScheduledByID": "9012e10f-93f3-4eb4-b898-c5db22aa296f",
"DeletedDates": [
"2026-07-07T15:38:19Z",
"2026-07-07T15:38:19Z"
],
"ClearedDates": [
"2026-07-07T15:38:19Z",
"2026-07-07T15:38: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-07-07T15:38:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-07T15:38:19Z",
"CreateDate": "2026-07-07T15:38:19Z",
"OccurTime": "2026-07-07T15:38:19Z",
"OccurEndTime": "2026-07-07T15:38:19Z",
"StartTime": "2026-07-07T15:38:19Z",
"EndTime": "2026-07-07T15:38:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"70adca29-040d-42d4-bcaa-1cac61eea37c",
"6c9222c1-3312-4ea3-81ba-4924c5a0cd55"
],
"Companies": [
"25802e99-c7e8-4101-bc26-7e995f3568f5",
"b4c8037a-b644-447c-8943-024c3471011c"
],
"Groups": [
"7643d064-a661-4d24-9675-bd2d2e0880bd",
"7e68e1a1-d1e5-4bd7-ade6-6f5f1f04590f"
],
"Opportunities": [
"f38ee190-b1c5-4e86-a79d-c13574264509",
"ef04c1e9-0f4f-457a-9cb1-51d21b44268c"
]
}
},
{
"Id": "ce806ab0-420d-4640-b341-42234c711ff5",
"SeriesId": "2b0fa8e2-018b-4c57-b38b-d078420d44bb",
"AccessorID": "1bd6318a-74f0-40b5-8479-ff34c4cb00ee",
"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": "305f7a2b-2d6a-4921-9dc3-80d6848b38aa",
"ScheduledByID": "9012e10f-93f3-4eb4-b898-c5db22aa296f",
"DeletedDates": [
"2026-07-07T15:38:19Z",
"2026-07-07T15:38:19Z"
],
"ClearedDates": [
"2026-07-07T15:38:19Z",
"2026-07-07T15:38: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-07-07T15:38:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-07T15:38:19Z",
"CreateDate": "2026-07-07T15:38:19Z",
"OccurTime": "2026-07-07T15:38:19Z",
"OccurEndTime": "2026-07-07T15:38:19Z",
"StartTime": "2026-07-07T15:38:19Z",
"EndTime": "2026-07-07T15:38:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"70adca29-040d-42d4-bcaa-1cac61eea37c",
"6c9222c1-3312-4ea3-81ba-4924c5a0cd55"
],
"Companies": [
"25802e99-c7e8-4101-bc26-7e995f3568f5",
"b4c8037a-b644-447c-8943-024c3471011c"
],
"Groups": [
"7643d064-a661-4d24-9675-bd2d2e0880bd",
"7e68e1a1-d1e5-4bd7-ade6-6f5f1f04590f"
],
"Opportunities": [
"f38ee190-b1c5-4e86-a79d-c13574264509",
"ef04c1e9-0f4f-457a-9cb1-51d21b44268c"
]
}
}
]