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 ActivityName | 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": "3b9aff8d-167d-4d94-83c2-e02720bdb232", "SeriesId": "78d1169c-cafe-4737-a95e-be99d84cba88", "AccessorID": "dc96b170-0db9-4bb1-b4df-f34058d148ee", "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": "1a036b8d-7479-466a-942a-55fefb49530c", "ScheduledByID": "8ac98267-5282-46e6-b452-be88e6f5445e", "DeletedDates": [ "2025-07-05T09:02:37Z", "2025-07-05T09:02:37Z" ], "ClearedDates": [ "2025-07-05T09:02:37Z", "2025-07-05T09:02:37Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-07-05T09:02:37Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-07-05T09:02:37Z", "CreateDate": "2025-07-05T09:02:37Z", "OccurTime": "2025-07-05T09:02:37Z", "OccurEndTime": "2025-07-05T09:02:37Z", "StartTime": "2025-07-05T09:02:37Z", "EndTime": "2025-07-05T09:02:37Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c2e55455-5cee-4409-9982-b3833ef95488", "89a612d5-5288-4be7-bc6b-aeb48d5e4389" ], "Companies": [ "1232f3b8-42f1-4049-b6c9-b1bbd3868364", "901b1099-2d79-42b3-987b-363c18035b11" ], "Groups": [ "b8ce348e-e4ac-49d4-a966-8e6459b97c52", "3bda58ea-e3f6-4299-8a89-876020559c95" ], "Opportunities": [ "fb392f13-3c2f-4a63-ae3f-28509435ca45", "f4e2d171-a67e-4cdc-9202-3bfce2dad85d" ] } }, { "Id": "3b9aff8d-167d-4d94-83c2-e02720bdb232", "SeriesId": "78d1169c-cafe-4737-a95e-be99d84cba88", "AccessorID": "dc96b170-0db9-4bb1-b4df-f34058d148ee", "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": "1a036b8d-7479-466a-942a-55fefb49530c", "ScheduledByID": "8ac98267-5282-46e6-b452-be88e6f5445e", "DeletedDates": [ "2025-07-05T09:02:37Z", "2025-07-05T09:02:37Z" ], "ClearedDates": [ "2025-07-05T09:02:37Z", "2025-07-05T09:02:37Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-07-05T09:02:37Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-07-05T09:02:37Z", "CreateDate": "2025-07-05T09:02:37Z", "OccurTime": "2025-07-05T09:02:37Z", "OccurEndTime": "2025-07-05T09:02:37Z", "StartTime": "2025-07-05T09:02:37Z", "EndTime": "2025-07-05T09:02:37Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c2e55455-5cee-4409-9982-b3833ef95488", "89a612d5-5288-4be7-bc6b-aeb48d5e4389" ], "Companies": [ "1232f3b8-42f1-4049-b6c9-b1bbd3868364", "901b1099-2d79-42b3-987b-363c18035b11" ], "Groups": [ "b8ce348e-e4ac-49d4-a966-8e6459b97c52", "3bda58ea-e3f6-4299-8a89-876020559c95" ], "Opportunities": [ "fb392f13-3c2f-4a63-ae3f-28509435ca45", "f4e2d171-a67e-4cdc-9202-3bfce2dad85d" ] } } ]