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": "6178bbc2-5d79-47c5-bfd5-a9c8adabf380",
"SeriesId": "82991bbc-0c30-4d49-b621-97ce128a5bc4",
"AccessorID": "be1ba41f-1771-4ca8-b7c9-a092f7194c7b",
"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": "11c27c88-1067-493a-ab14-540f62b6953c",
"ScheduledByID": "5e91e062-5d8b-4bcf-b63c-1b89c0d4bc18",
"DeletedDates": [
"2026-10-15T08:57:52Z",
"2026-10-15T08:57:52Z"
],
"ClearedDates": [
"2026-10-15T08:57:52Z",
"2026-10-15T08:57:52Z"
],
"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-15T08:57:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-15T08:57:52Z",
"CreateDate": "2026-10-15T08:57:52Z",
"OccurTime": "2026-10-15T08:57:52Z",
"OccurEndTime": "2026-10-15T08:57:52Z",
"StartTime": "2026-10-15T08:57:52Z",
"EndTime": "2026-10-15T08:57:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1403a728-920d-46e2-9b09-d97d0a1ead06",
"cf736481-5868-4913-9a2f-52c7ed0f5571"
],
"Companies": [
"c1affc83-b63a-4306-bed2-6d7e867a6bdd",
"c83f406e-1f5e-4ab7-945d-78cf17e6400e"
],
"Groups": [
"376f2745-7a0c-4c5f-8626-c7bee209a0aa",
"95b1c059-6b41-43d0-b0e0-f24c29a9d57c"
],
"Opportunities": [
"15b79567-7f63-4563-bd5f-bbef6c7ec6d3",
"daa6b7d8-c2c9-4ee2-8a70-1b38b80394d3"
]
}
},
{
"Id": "6178bbc2-5d79-47c5-bfd5-a9c8adabf380",
"SeriesId": "82991bbc-0c30-4d49-b621-97ce128a5bc4",
"AccessorID": "be1ba41f-1771-4ca8-b7c9-a092f7194c7b",
"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": "11c27c88-1067-493a-ab14-540f62b6953c",
"ScheduledByID": "5e91e062-5d8b-4bcf-b63c-1b89c0d4bc18",
"DeletedDates": [
"2026-10-15T08:57:52Z",
"2026-10-15T08:57:52Z"
],
"ClearedDates": [
"2026-10-15T08:57:52Z",
"2026-10-15T08:57:52Z"
],
"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-15T08:57:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-15T08:57:52Z",
"CreateDate": "2026-10-15T08:57:52Z",
"OccurTime": "2026-10-15T08:57:52Z",
"OccurEndTime": "2026-10-15T08:57:52Z",
"StartTime": "2026-10-15T08:57:52Z",
"EndTime": "2026-10-15T08:57:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"1403a728-920d-46e2-9b09-d97d0a1ead06",
"cf736481-5868-4913-9a2f-52c7ed0f5571"
],
"Companies": [
"c1affc83-b63a-4306-bed2-6d7e867a6bdd",
"c83f406e-1f5e-4ab7-945d-78cf17e6400e"
],
"Groups": [
"376f2745-7a0c-4c5f-8626-c7bee209a0aa",
"95b1c059-6b41-43d0-b0e0-f24c29a9d57c"
],
"Opportunities": [
"15b79567-7f63-4563-bd5f-bbef6c7ec6d3",
"daa6b7d8-c2c9-4ee2-8a70-1b38b80394d3"
]
}
}
]