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": "f3a63fb7-cf96-409d-bc6a-d3f1d07657c3", "SeriesId": "63578754-dbcb-42d1-b684-1b1b3d09a849", "AccessorID": "9f2e3aa1-7ecf-41cc-8b5d-c769c3d04ab0", "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": "96d865bc-4664-4b3b-b323-a85314b9a268", "ScheduledByID": "9657ae80-5bde-4453-b68a-9ce51f15e9ff", "DeletedDates": [ "2024-05-08T00:25:21Z", "2024-05-08T00:25:21Z" ], "ClearedDates": [ "2024-05-08T00:25:21Z", "2024-05-08T00:25:21Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2024-05-08T00:25:21Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T00:25:21Z", "CreateDate": "2024-05-08T00:25:21Z", "OccurTime": "2024-05-08T00:25:21Z", "OccurEndTime": "2024-05-08T00:25:21Z", "StartTime": "2024-05-08T00:25:21Z", "EndTime": "2024-05-08T00:25:21Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "2a676d61-d070-4e86-a184-308ba5b4b8f7", "b2921b43-505f-4577-ac12-dac1a38e4549" ], "Companies": [ "bf3eaaa2-82a9-4b9c-a3a5-8df9421ad513", "3f829a3c-c832-4553-ac8e-1d3a45f5fc8b" ], "Groups": [ "a0b4644f-b2e9-4ee7-8104-4d57e92b932d", "72c36f81-f49a-465d-af24-faf86264a4eb" ], "Opportunities": [ "40f79582-6951-463b-ae83-0e9b88fa1106", "b1f5ac17-a156-4e73-b652-6810c7d8dfce" ] } }, { "Id": "f3a63fb7-cf96-409d-bc6a-d3f1d07657c3", "SeriesId": "63578754-dbcb-42d1-b684-1b1b3d09a849", "AccessorID": "9f2e3aa1-7ecf-41cc-8b5d-c769c3d04ab0", "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": "96d865bc-4664-4b3b-b323-a85314b9a268", "ScheduledByID": "9657ae80-5bde-4453-b68a-9ce51f15e9ff", "DeletedDates": [ "2024-05-08T00:25:21Z", "2024-05-08T00:25:21Z" ], "ClearedDates": [ "2024-05-08T00:25:21Z", "2024-05-08T00:25:21Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2024-05-08T00:25:21Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T00:25:21Z", "CreateDate": "2024-05-08T00:25:21Z", "OccurTime": "2024-05-08T00:25:21Z", "OccurEndTime": "2024-05-08T00:25:21Z", "StartTime": "2024-05-08T00:25:21Z", "EndTime": "2024-05-08T00:25:21Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "2a676d61-d070-4e86-a184-308ba5b4b8f7", "b2921b43-505f-4577-ac12-dac1a38e4549" ], "Companies": [ "bf3eaaa2-82a9-4b9c-a3a5-8df9421ad513", "3f829a3c-c832-4553-ac8e-1d3a45f5fc8b" ], "Groups": [ "a0b4644f-b2e9-4ee7-8104-4d57e92b932d", "72c36f81-f49a-465d-af24-faf86264a4eb" ], "Opportunities": [ "40f79582-6951-463b-ae83-0e9b88fa1106", "b1f5ac17-a156-4e73-b652-6810c7d8dfce" ] } } ]