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": "fc59ed3c-537d-47d7-a371-2d82c382724e",
"SeriesId": "b4f7dbbf-9e87-4533-a9f6-b90c691743da",
"AccessorID": "7459cf52-9d9a-42ed-831a-bcf0200d1e51",
"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": "16cf88db-3e86-4e77-8071-dd43ed7b69b8",
"ScheduledByID": "28475391-15e3-4405-8b13-0c40cbca7b99",
"DeletedDates": [
"2026-10-23T21:31:57Z",
"2026-10-23T21:31:57Z"
],
"ClearedDates": [
"2026-10-23T21:31:57Z",
"2026-10-23T21:31:57Z"
],
"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-23T21:31:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-23T21:31:57Z",
"CreateDate": "2026-10-23T21:31:57Z",
"OccurTime": "2026-10-23T21:31:57Z",
"OccurEndTime": "2026-10-23T21:31:57Z",
"StartTime": "2026-10-23T21:31:57Z",
"EndTime": "2026-10-23T21:31:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b7fabb6c-34ac-4e92-89ef-86a6ad911357",
"a2e6d014-1cde-4422-b470-5aea95a6747e"
],
"Companies": [
"09d8448a-333d-4734-a141-68186491dcb2",
"4f272c8d-c956-466f-93e3-f8e25f72d121"
],
"Groups": [
"ca6bc52f-4998-4266-afcd-124bd53d23ef",
"a8bdc472-525f-4857-b7da-faf4c029d175"
],
"Opportunities": [
"cab4e416-9b7c-4e25-a161-c08c39e453ee",
"fccc5798-76fc-439c-9b33-2a277a3f6b2f"
]
}
},
{
"Id": "fc59ed3c-537d-47d7-a371-2d82c382724e",
"SeriesId": "b4f7dbbf-9e87-4533-a9f6-b90c691743da",
"AccessorID": "7459cf52-9d9a-42ed-831a-bcf0200d1e51",
"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": "16cf88db-3e86-4e77-8071-dd43ed7b69b8",
"ScheduledByID": "28475391-15e3-4405-8b13-0c40cbca7b99",
"DeletedDates": [
"2026-10-23T21:31:57Z",
"2026-10-23T21:31:57Z"
],
"ClearedDates": [
"2026-10-23T21:31:57Z",
"2026-10-23T21:31:57Z"
],
"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-23T21:31:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-23T21:31:57Z",
"CreateDate": "2026-10-23T21:31:57Z",
"OccurTime": "2026-10-23T21:31:57Z",
"OccurEndTime": "2026-10-23T21:31:57Z",
"StartTime": "2026-10-23T21:31:57Z",
"EndTime": "2026-10-23T21:31:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b7fabb6c-34ac-4e92-89ef-86a6ad911357",
"a2e6d014-1cde-4422-b470-5aea95a6747e"
],
"Companies": [
"09d8448a-333d-4734-a141-68186491dcb2",
"4f272c8d-c956-466f-93e3-f8e25f72d121"
],
"Groups": [
"ca6bc52f-4998-4266-afcd-124bd53d23ef",
"a8bdc472-525f-4857-b7da-faf4c029d175"
],
"Opportunities": [
"cab4e416-9b7c-4e25-a161-c08c39e453ee",
"fccc5798-76fc-439c-9b33-2a277a3f6b2f"
]
}
}
]