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": "0a1c84ee-861e-4124-9212-c3665a924ca5",
"SeriesId": "e36f7351-2853-4fc8-8236-dfdd6f8bee0b",
"AccessorID": "8da012f5-d686-49ed-a2ea-745df757ca5f",
"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": "90db6fa9-5318-4c97-93fd-5db0b4a756ff",
"ScheduledByID": "d559aece-a037-4afe-81b5-722d94d4645e",
"DeletedDates": [
"2026-08-30T11:22:57Z",
"2026-08-30T11:22:57Z"
],
"ClearedDates": [
"2026-08-30T11:22:57Z",
"2026-08-30T11:22: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-08-30T11:22:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-30T11:22:57Z",
"CreateDate": "2026-08-30T11:22:57Z",
"OccurTime": "2026-08-30T11:22:57Z",
"OccurEndTime": "2026-08-30T11:22:57Z",
"StartTime": "2026-08-30T11:22:57Z",
"EndTime": "2026-08-30T11:22:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4ef20698-5ee1-47a9-980d-ce389c050c7f",
"3787b657-108a-4bb4-83c1-d39993c1dcef"
],
"Companies": [
"891c5d23-0b93-4dc6-a103-72004f75fe9e",
"e2de3f22-135e-4fa8-8b23-95ebd8b8b940"
],
"Groups": [
"1890c74a-d48a-4dc0-a32f-104710acd613",
"4cb786b4-858c-49f4-802b-60b7d6b87a15"
],
"Opportunities": [
"f9bdd26d-af00-4a35-b491-b4fdeb1b0f44",
"f7e32ec5-d62f-4924-a2c5-8d07bed10fed"
]
}
},
{
"Id": "0a1c84ee-861e-4124-9212-c3665a924ca5",
"SeriesId": "e36f7351-2853-4fc8-8236-dfdd6f8bee0b",
"AccessorID": "8da012f5-d686-49ed-a2ea-745df757ca5f",
"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": "90db6fa9-5318-4c97-93fd-5db0b4a756ff",
"ScheduledByID": "d559aece-a037-4afe-81b5-722d94d4645e",
"DeletedDates": [
"2026-08-30T11:22:57Z",
"2026-08-30T11:22:57Z"
],
"ClearedDates": [
"2026-08-30T11:22:57Z",
"2026-08-30T11:22: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-08-30T11:22:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-30T11:22:57Z",
"CreateDate": "2026-08-30T11:22:57Z",
"OccurTime": "2026-08-30T11:22:57Z",
"OccurEndTime": "2026-08-30T11:22:57Z",
"StartTime": "2026-08-30T11:22:57Z",
"EndTime": "2026-08-30T11:22:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4ef20698-5ee1-47a9-980d-ce389c050c7f",
"3787b657-108a-4bb4-83c1-d39993c1dcef"
],
"Companies": [
"891c5d23-0b93-4dc6-a103-72004f75fe9e",
"e2de3f22-135e-4fa8-8b23-95ebd8b8b940"
],
"Groups": [
"1890c74a-d48a-4dc0-a32f-104710acd613",
"4cb786b4-858c-49f4-802b-60b7d6b87a15"
],
"Opportunities": [
"f9bdd26d-af00-4a35-b491-b4fdeb1b0f44",
"f7e32ec5-d62f-4924-a2c5-8d07bed10fed"
]
}
}
]