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": "651b25c4-90fa-4cfd-9eb9-f4d1b1a132ee",
"SeriesId": "def2a7f0-900e-456f-8eac-e65d547abbba",
"AccessorID": "3b3e52cd-e3e4-423c-89c6-d2c83875c455",
"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": "329c8239-1f5d-41a2-8203-7072bdf5866c",
"ScheduledByID": "33ad2072-47c1-4510-a1b2-d9d2036d8eed",
"DeletedDates": [
"2026-08-17T07:54:44Z",
"2026-08-17T07:54:44Z"
],
"ClearedDates": [
"2026-08-17T07:54:44Z",
"2026-08-17T07:54:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-17T07:54:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-17T07:54:44Z",
"CreateDate": "2026-08-17T07:54:44Z",
"OccurTime": "2026-08-17T07:54:44Z",
"OccurEndTime": "2026-08-17T07:54:44Z",
"StartTime": "2026-08-17T07:54:44Z",
"EndTime": "2026-08-17T07:54:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"534c87a0-e13a-4946-b7ee-534b91d3a4f4",
"d63490f9-a5fd-4fa8-90b3-79968b334442"
],
"Companies": [
"0d1bc7d2-7928-44a5-8f38-6fd371a8e1ee",
"b5a4a3e6-e136-4890-9165-08ccbedfbeca"
],
"Groups": [
"c4a5caf1-79ca-4532-8f2b-b9428fc9708e",
"2c06dc86-91f9-4959-a0f6-7ef407c9d9c0"
],
"Opportunities": [
"9c10f187-a5ce-4286-95e9-eec40b28aef9",
"b031ddaa-a572-4ae4-879f-36109aea74ef"
]
}
},
{
"Id": "651b25c4-90fa-4cfd-9eb9-f4d1b1a132ee",
"SeriesId": "def2a7f0-900e-456f-8eac-e65d547abbba",
"AccessorID": "3b3e52cd-e3e4-423c-89c6-d2c83875c455",
"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": "329c8239-1f5d-41a2-8203-7072bdf5866c",
"ScheduledByID": "33ad2072-47c1-4510-a1b2-d9d2036d8eed",
"DeletedDates": [
"2026-08-17T07:54:44Z",
"2026-08-17T07:54:44Z"
],
"ClearedDates": [
"2026-08-17T07:54:44Z",
"2026-08-17T07:54:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-17T07:54:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-17T07:54:44Z",
"CreateDate": "2026-08-17T07:54:44Z",
"OccurTime": "2026-08-17T07:54:44Z",
"OccurEndTime": "2026-08-17T07:54:44Z",
"StartTime": "2026-08-17T07:54:44Z",
"EndTime": "2026-08-17T07:54:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"534c87a0-e13a-4946-b7ee-534b91d3a4f4",
"d63490f9-a5fd-4fa8-90b3-79968b334442"
],
"Companies": [
"0d1bc7d2-7928-44a5-8f38-6fd371a8e1ee",
"b5a4a3e6-e136-4890-9165-08ccbedfbeca"
],
"Groups": [
"c4a5caf1-79ca-4532-8f2b-b9428fc9708e",
"2c06dc86-91f9-4959-a0f6-7ef407c9d9c0"
],
"Opportunities": [
"9c10f187-a5ce-4286-95e9-eec40b28aef9",
"b031ddaa-a572-4ae4-879f-36109aea74ef"
]
}
}
]