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": "00d0e1b2-5139-4f5f-8475-8d0173b1cc30",
"SeriesId": "b9a1fd1b-f481-4618-b863-7919aa34ef45",
"AccessorID": "0ebfd9b3-c86a-42c4-a054-da71fa9a2485",
"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": "ff71ad5e-94c9-4d9a-8477-359f83685e2a",
"ScheduledByID": "a6dccb51-00b3-43f8-9673-655a19f5e512",
"DeletedDates": [
"2026-05-26T14:41:02Z",
"2026-05-26T14:41:02Z"
],
"ClearedDates": [
"2026-05-26T14:41:02Z",
"2026-05-26T14:41:02Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-26T14:41:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-26T14:41:02Z",
"CreateDate": "2026-05-26T14:41:02Z",
"OccurTime": "2026-05-26T14:41:02Z",
"OccurEndTime": "2026-05-26T14:41:02Z",
"StartTime": "2026-05-26T14:41:02Z",
"EndTime": "2026-05-26T14:41:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"55e95ccc-8bc2-4c0c-b022-cf72bd78c7ae",
"67092059-9241-43ae-a85a-0c4f9559e3d4"
],
"Companies": [
"a073a4f0-451a-4fd0-bd7b-d1b56e2a811a",
"73d87f25-8005-4444-a6fa-c3345e0188c2"
],
"Groups": [
"cf9430d9-6760-47c9-bcf1-a2edc93a7daa",
"c01e762c-506f-4789-9b54-9fbdc5cac097"
],
"Opportunities": [
"7e5f79af-5fa3-42a4-966c-0c6c74c8063b",
"e3e9306a-6fd1-4fe2-a0ca-c1ee31ae75a2"
]
}
},
{
"Id": "00d0e1b2-5139-4f5f-8475-8d0173b1cc30",
"SeriesId": "b9a1fd1b-f481-4618-b863-7919aa34ef45",
"AccessorID": "0ebfd9b3-c86a-42c4-a054-da71fa9a2485",
"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": "ff71ad5e-94c9-4d9a-8477-359f83685e2a",
"ScheduledByID": "a6dccb51-00b3-43f8-9673-655a19f5e512",
"DeletedDates": [
"2026-05-26T14:41:02Z",
"2026-05-26T14:41:02Z"
],
"ClearedDates": [
"2026-05-26T14:41:02Z",
"2026-05-26T14:41:02Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-26T14:41:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-26T14:41:02Z",
"CreateDate": "2026-05-26T14:41:02Z",
"OccurTime": "2026-05-26T14:41:02Z",
"OccurEndTime": "2026-05-26T14:41:02Z",
"StartTime": "2026-05-26T14:41:02Z",
"EndTime": "2026-05-26T14:41:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"55e95ccc-8bc2-4c0c-b022-cf72bd78c7ae",
"67092059-9241-43ae-a85a-0c4f9559e3d4"
],
"Companies": [
"a073a4f0-451a-4fd0-bd7b-d1b56e2a811a",
"73d87f25-8005-4444-a6fa-c3345e0188c2"
],
"Groups": [
"cf9430d9-6760-47c9-bcf1-a2edc93a7daa",
"c01e762c-506f-4789-9b54-9fbdc5cac097"
],
"Opportunities": [
"7e5f79af-5fa3-42a4-966c-0c6c74c8063b",
"e3e9306a-6fd1-4fe2-a0ca-c1ee31ae75a2"
]
}
}
]