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": "653b5f6b-628a-4842-9943-23f88800ff6b",
"SeriesId": "a93b94dd-9835-43ff-8d0a-c4b627fbd7ab",
"AccessorID": "d041925f-f2f0-450c-b8dd-99a284de533d",
"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": "4a425699-66d0-4af8-bdd3-4c40cec17b9c",
"ScheduledByID": "d1534bab-3eed-4ee0-a2a1-21837474f9c8",
"DeletedDates": [
"2026-11-09T13:14:45Z",
"2026-11-09T13:14:45Z"
],
"ClearedDates": [
"2026-11-09T13:14:45Z",
"2026-11-09T13:14:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-09T13:14:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-09T13:14:45Z",
"CreateDate": "2026-11-09T13:14:45Z",
"OccurTime": "2026-11-09T13:14:45Z",
"OccurEndTime": "2026-11-09T13:14:45Z",
"StartTime": "2026-11-09T13:14:45Z",
"EndTime": "2026-11-09T13:14:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"eb357f36-0eb1-4229-915d-35dd8c896bf8",
"9c446e5b-ab8f-41d6-b8a9-395c8250a2a4"
],
"Companies": [
"fdd12715-ffa9-4fbb-b69c-a6afa45e90b8",
"95f1e856-3e82-45d9-91e9-b591ae417e6c"
],
"Groups": [
"d1034ab3-046c-4551-a272-72ea8b3d8f77",
"f85c0877-377d-4784-ac30-bd95bef45a33"
],
"Opportunities": [
"d514f589-2d19-4824-8a12-a110350bdcc9",
"b8cd3789-dab3-4ccb-ad43-0160ea56d05d"
]
}
},
{
"Id": "653b5f6b-628a-4842-9943-23f88800ff6b",
"SeriesId": "a93b94dd-9835-43ff-8d0a-c4b627fbd7ab",
"AccessorID": "d041925f-f2f0-450c-b8dd-99a284de533d",
"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": "4a425699-66d0-4af8-bdd3-4c40cec17b9c",
"ScheduledByID": "d1534bab-3eed-4ee0-a2a1-21837474f9c8",
"DeletedDates": [
"2026-11-09T13:14:45Z",
"2026-11-09T13:14:45Z"
],
"ClearedDates": [
"2026-11-09T13:14:45Z",
"2026-11-09T13:14:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-09T13:14:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-09T13:14:45Z",
"CreateDate": "2026-11-09T13:14:45Z",
"OccurTime": "2026-11-09T13:14:45Z",
"OccurEndTime": "2026-11-09T13:14:45Z",
"StartTime": "2026-11-09T13:14:45Z",
"EndTime": "2026-11-09T13:14:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"eb357f36-0eb1-4229-915d-35dd8c896bf8",
"9c446e5b-ab8f-41d6-b8a9-395c8250a2a4"
],
"Companies": [
"fdd12715-ffa9-4fbb-b69c-a6afa45e90b8",
"95f1e856-3e82-45d9-91e9-b591ae417e6c"
],
"Groups": [
"d1034ab3-046c-4551-a272-72ea8b3d8f77",
"f85c0877-377d-4784-ac30-bd95bef45a33"
],
"Opportunities": [
"d514f589-2d19-4824-8a12-a110350bdcc9",
"b8cd3789-dab3-4ccb-ad43-0160ea56d05d"
]
}
}
]