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": "34c49545-6f99-40b8-a1f6-a1806af7af72", "SeriesId": "83803e77-c4cc-44a0-a74d-99ef05bdb332", "AccessorID": "d747721d-5c6c-4946-af4c-8f91c07bed38", "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": "e18f7b6b-6786-469e-930e-92fb55d9644b", "ScheduledByID": "9c931a1d-0b43-41c9-8b57-167bacbae207", "DeletedDates": [ "2025-04-11T07:16:22Z", "2025-04-11T07:16:22Z" ], "ClearedDates": [ "2025-04-11T07:16:22Z", "2025-04-11T07:16:22Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-04-11T07:16:22Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-04-11T07:16:22Z", "CreateDate": "2025-04-11T07:16:22Z", "OccurTime": "2025-04-11T07:16:22Z", "OccurEndTime": "2025-04-11T07:16:22Z", "StartTime": "2025-04-11T07:16:22Z", "EndTime": "2025-04-11T07:16:22Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "63113e0c-e14a-4e9a-8ef3-5f25a9ac448e", "11b45ed6-1597-4723-8a61-d6b7e792c2d4" ], "Companies": [ "c34f7fd5-519f-488d-bd0b-b9b217dd653b", "c36ec1da-5fd4-4849-8e12-bf9f78c0eaf1" ], "Groups": [ "89754f08-5fce-4445-8a39-9772798d13d8", "72108c90-72a1-458a-a4a3-ef403e981ab3" ], "Opportunities": [ "da76b685-250e-43ab-831d-b04c414a48f8", "399e9ace-c67b-434f-9f25-87287e076139" ] } }, { "Id": "34c49545-6f99-40b8-a1f6-a1806af7af72", "SeriesId": "83803e77-c4cc-44a0-a74d-99ef05bdb332", "AccessorID": "d747721d-5c6c-4946-af4c-8f91c07bed38", "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": "e18f7b6b-6786-469e-930e-92fb55d9644b", "ScheduledByID": "9c931a1d-0b43-41c9-8b57-167bacbae207", "DeletedDates": [ "2025-04-11T07:16:22Z", "2025-04-11T07:16:22Z" ], "ClearedDates": [ "2025-04-11T07:16:22Z", "2025-04-11T07:16:22Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-04-11T07:16:22Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-04-11T07:16:22Z", "CreateDate": "2025-04-11T07:16:22Z", "OccurTime": "2025-04-11T07:16:22Z", "OccurEndTime": "2025-04-11T07:16:22Z", "StartTime": "2025-04-11T07:16:22Z", "EndTime": "2025-04-11T07:16:22Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "63113e0c-e14a-4e9a-8ef3-5f25a9ac448e", "11b45ed6-1597-4723-8a61-d6b7e792c2d4" ], "Companies": [ "c34f7fd5-519f-488d-bd0b-b9b217dd653b", "c36ec1da-5fd4-4849-8e12-bf9f78c0eaf1" ], "Groups": [ "89754f08-5fce-4445-8a39-9772798d13d8", "72108c90-72a1-458a-a4a3-ef403e981ab3" ], "Opportunities": [ "da76b685-250e-43ab-831d-b04c414a48f8", "399e9ace-c67b-434f-9f25-87287e076139" ] } } ]