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": "d47025f3-39a7-4308-a4c8-b0c4c631b506", "SeriesId": "f824e35a-c817-42b9-a7a6-cc3b7b258ec2", "AccessorID": "c0418508-c101-44f0-b4a3-b305aef1a62e", "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": "f2df16b3-5b2a-4337-84b1-5dd15084b304", "ScheduledByID": "dd267bae-093a-4171-a770-f7abdf7339d1", "DeletedDates": [ "2025-06-03T07:55:43Z", "2025-06-03T07:55:43Z" ], "ClearedDates": [ "2025-06-03T07:55:43Z", "2025-06-03T07:55:43Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-06-03T07:55:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-06-03T07:55:43Z", "CreateDate": "2025-06-03T07:55:43Z", "OccurTime": "2025-06-03T07:55:43Z", "OccurEndTime": "2025-06-03T07:55:43Z", "StartTime": "2025-06-03T07:55:43Z", "EndTime": "2025-06-03T07:55:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "5448ae09-185c-4337-835e-6b4b750d19f4", "7d090d36-e725-425c-b67f-3e4ecd6db54f" ], "Companies": [ "812e5c58-71f8-4608-8e01-886d49eaba06", "8193628d-c196-43b9-9b7a-03d01f58ddb2" ], "Groups": [ "3cdfc9ed-32fc-4f37-9ba4-4f7baa465f14", "86baa13f-3f13-4052-87a4-ec1f8feaaf02" ], "Opportunities": [ "a6703138-792a-4a9a-bf63-7d35c8a7789c", "6f6a71f0-06d6-4274-bfb9-a251e47b57d0" ] } }, { "Id": "d47025f3-39a7-4308-a4c8-b0c4c631b506", "SeriesId": "f824e35a-c817-42b9-a7a6-cc3b7b258ec2", "AccessorID": "c0418508-c101-44f0-b4a3-b305aef1a62e", "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": "f2df16b3-5b2a-4337-84b1-5dd15084b304", "ScheduledByID": "dd267bae-093a-4171-a770-f7abdf7339d1", "DeletedDates": [ "2025-06-03T07:55:43Z", "2025-06-03T07:55:43Z" ], "ClearedDates": [ "2025-06-03T07:55:43Z", "2025-06-03T07:55:43Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-06-03T07:55:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-06-03T07:55:43Z", "CreateDate": "2025-06-03T07:55:43Z", "OccurTime": "2025-06-03T07:55:43Z", "OccurEndTime": "2025-06-03T07:55:43Z", "StartTime": "2025-06-03T07:55:43Z", "EndTime": "2025-06-03T07:55:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "5448ae09-185c-4337-835e-6b4b750d19f4", "7d090d36-e725-425c-b67f-3e4ecd6db54f" ], "Companies": [ "812e5c58-71f8-4608-8e01-886d49eaba06", "8193628d-c196-43b9-9b7a-03d01f58ddb2" ], "Groups": [ "3cdfc9ed-32fc-4f37-9ba4-4f7baa465f14", "86baa13f-3f13-4052-87a4-ec1f8feaaf02" ], "Opportunities": [ "a6703138-792a-4a9a-bf63-7d35c8a7789c", "6f6a71f0-06d6-4274-bfb9-a251e47b57d0" ] } } ]