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": "ce428223-9262-42f9-a0ee-07f70774d012", "SeriesId": "e3272110-b8a2-4cbb-9d84-b67713ccecd1", "AccessorID": "d56488e6-7592-4737-bef8-9c56baa5b7e4", "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": "c6e4a146-13f0-4068-8de1-10184a4a98d1", "ScheduledByID": "9363db5d-df6d-4107-bebe-7b51b0bc4c12", "DeletedDates": [ "2025-09-18T22:11:28Z", "2025-09-18T22:11:28Z" ], "ClearedDates": [ "2025-09-18T22:11:28Z", "2025-09-18T22:11:28Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-09-18T22:11:29Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-09-18T22:11:29Z", "CreateDate": "2025-09-18T22:11:29Z", "OccurTime": "2025-09-18T22:11:29Z", "OccurEndTime": "2025-09-18T22:11:29Z", "StartTime": "2025-09-18T22:11:29Z", "EndTime": "2025-09-18T22:11:29Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "4e9f6fea-303d-4fdb-97f7-fbd26c879dca", "73c5b549-a2d7-4c7f-aede-921138d366ce" ], "Companies": [ "30d3c9a4-a47a-4726-a3ac-f1c5ccb7e445", "60fe9c52-f94f-44ec-99c5-be6307f03072" ], "Groups": [ "2a8ec04d-08c7-431b-8dd2-e004fab3189a", "f7c9069e-9bfd-424b-89b0-f64480e29179" ], "Opportunities": [ "c1fc4218-b0ad-416e-8dab-ff722b683a08", "3c563346-94ff-474f-a33c-237cd8c2604a" ] } }, { "Id": "ce428223-9262-42f9-a0ee-07f70774d012", "SeriesId": "e3272110-b8a2-4cbb-9d84-b67713ccecd1", "AccessorID": "d56488e6-7592-4737-bef8-9c56baa5b7e4", "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": "c6e4a146-13f0-4068-8de1-10184a4a98d1", "ScheduledByID": "9363db5d-df6d-4107-bebe-7b51b0bc4c12", "DeletedDates": [ "2025-09-18T22:11:28Z", "2025-09-18T22:11:28Z" ], "ClearedDates": [ "2025-09-18T22:11:28Z", "2025-09-18T22:11:28Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-09-18T22:11:29Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-09-18T22:11:29Z", "CreateDate": "2025-09-18T22:11:29Z", "OccurTime": "2025-09-18T22:11:29Z", "OccurEndTime": "2025-09-18T22:11:29Z", "StartTime": "2025-09-18T22:11:29Z", "EndTime": "2025-09-18T22:11:29Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "4e9f6fea-303d-4fdb-97f7-fbd26c879dca", "73c5b549-a2d7-4c7f-aede-921138d366ce" ], "Companies": [ "30d3c9a4-a47a-4726-a3ac-f1c5ccb7e445", "60fe9c52-f94f-44ec-99c5-be6307f03072" ], "Groups": [ "2a8ec04d-08c7-431b-8dd2-e004fab3189a", "f7c9069e-9bfd-424b-89b0-f64480e29179" ], "Opportunities": [ "c1fc4218-b0ad-416e-8dab-ff722b683a08", "3c563346-94ff-474f-a33c-237cd8c2604a" ] } } ]