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": "a0dcfd46-c307-481b-bd8c-0ff349b47a90",
"SeriesId": "c5cf2036-08d5-4a9c-8923-e0071086203d",
"AccessorID": "45ce4a5d-1242-4108-a2f1-9f31222e416c",
"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": "5756967e-bffd-4856-95c0-7d5b5f6ebeea",
"ScheduledByID": "c4e1fa55-39af-4f89-ab4c-3d3cc58366a5",
"DeletedDates": [
"2026-08-06T23:53:01Z",
"2026-08-06T23:53:01Z"
],
"ClearedDates": [
"2026-08-06T23:53:01Z",
"2026-08-06T23:53:01Z"
],
"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-06T23:53:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-06T23:53:01Z",
"CreateDate": "2026-08-06T23:53:01Z",
"OccurTime": "2026-08-06T23:53:01Z",
"OccurEndTime": "2026-08-06T23:53:01Z",
"StartTime": "2026-08-06T23:53:01Z",
"EndTime": "2026-08-06T23:53:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"02e3e275-9c0a-4a1c-a1c2-20e11e3ba63c",
"6788c22d-2b4f-4718-872e-bc4a442959ea"
],
"Companies": [
"233294a2-b808-4a03-920d-dd20de42ba36",
"63da68d7-9090-4031-afd6-a731e2423077"
],
"Groups": [
"25a2cd9a-a9b1-4643-a18f-42a8a2ca8453",
"677dc6be-2e00-44db-b68c-d53a84226876"
],
"Opportunities": [
"840a8bb2-2b5a-4cd7-a446-ddcf85340ae7",
"66c60795-3cfe-45a0-91fd-0ee8b323d683"
]
}
},
{
"Id": "a0dcfd46-c307-481b-bd8c-0ff349b47a90",
"SeriesId": "c5cf2036-08d5-4a9c-8923-e0071086203d",
"AccessorID": "45ce4a5d-1242-4108-a2f1-9f31222e416c",
"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": "5756967e-bffd-4856-95c0-7d5b5f6ebeea",
"ScheduledByID": "c4e1fa55-39af-4f89-ab4c-3d3cc58366a5",
"DeletedDates": [
"2026-08-06T23:53:01Z",
"2026-08-06T23:53:01Z"
],
"ClearedDates": [
"2026-08-06T23:53:01Z",
"2026-08-06T23:53:01Z"
],
"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-06T23:53:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-06T23:53:01Z",
"CreateDate": "2026-08-06T23:53:01Z",
"OccurTime": "2026-08-06T23:53:01Z",
"OccurEndTime": "2026-08-06T23:53:01Z",
"StartTime": "2026-08-06T23:53:01Z",
"EndTime": "2026-08-06T23:53:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"02e3e275-9c0a-4a1c-a1c2-20e11e3ba63c",
"6788c22d-2b4f-4718-872e-bc4a442959ea"
],
"Companies": [
"233294a2-b808-4a03-920d-dd20de42ba36",
"63da68d7-9090-4031-afd6-a731e2423077"
],
"Groups": [
"25a2cd9a-a9b1-4643-a18f-42a8a2ca8453",
"677dc6be-2e00-44db-b68c-d53a84226876"
],
"Opportunities": [
"840a8bb2-2b5a-4cd7-a446-ddcf85340ae7",
"66c60795-3cfe-45a0-91fd-0ee8b323d683"
]
}
}
]