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": "289a2cd4-a4d6-439c-b711-7c5ea2032e17", "SeriesId": "beef937c-1102-4906-b3bb-5fc179adf9bf", "AccessorID": "1eb81f19-0680-4ebf-bd9c-aa1bef71ee7a", "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": "bfcf0f0a-081d-494a-bad1-ee9bd2d648a2", "ScheduledByID": "c3730cc1-6cef-4d2f-975d-cfdeb5f4f059", "DeletedDates": [ "2024-05-15T21:49:32Z", "2024-05-15T21:49:32Z" ], "ClearedDates": [ "2024-05-15T21:49:32Z", "2024-05-15T21:49:32Z" ], "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-15T21:49:32Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-15T21:49:32Z", "CreateDate": "2024-05-15T21:49:32Z", "OccurTime": "2024-05-15T21:49:32Z", "OccurEndTime": "2024-05-15T21:49:32Z", "StartTime": "2024-05-15T21:49:32Z", "EndTime": "2024-05-15T21:49:32Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "774f5197-9dba-4a66-b16d-795fa4a9a285", "994da90a-7e71-43c4-aba9-5522a9087340" ], "Companies": [ "5aa2addb-356b-4f28-855f-1f52e30b093a", "f4f775ed-3322-400f-9341-978368a26e8c" ], "Groups": [ "c9b0a05a-3f85-4411-943e-9471609ef8bd", "1cb47d15-1e4f-42a0-80aa-485758364d47" ], "Opportunities": [ "be33b827-b4d8-4bee-9d6a-a4885ab57b78", "66e058ff-c905-416f-83c4-338636c37236" ] } }, { "Id": "289a2cd4-a4d6-439c-b711-7c5ea2032e17", "SeriesId": "beef937c-1102-4906-b3bb-5fc179adf9bf", "AccessorID": "1eb81f19-0680-4ebf-bd9c-aa1bef71ee7a", "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": "bfcf0f0a-081d-494a-bad1-ee9bd2d648a2", "ScheduledByID": "c3730cc1-6cef-4d2f-975d-cfdeb5f4f059", "DeletedDates": [ "2024-05-15T21:49:32Z", "2024-05-15T21:49:32Z" ], "ClearedDates": [ "2024-05-15T21:49:32Z", "2024-05-15T21:49:32Z" ], "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-15T21:49:32Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-15T21:49:32Z", "CreateDate": "2024-05-15T21:49:32Z", "OccurTime": "2024-05-15T21:49:32Z", "OccurEndTime": "2024-05-15T21:49:32Z", "StartTime": "2024-05-15T21:49:32Z", "EndTime": "2024-05-15T21:49:32Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "774f5197-9dba-4a66-b16d-795fa4a9a285", "994da90a-7e71-43c4-aba9-5522a9087340" ], "Companies": [ "5aa2addb-356b-4f28-855f-1f52e30b093a", "f4f775ed-3322-400f-9341-978368a26e8c" ], "Groups": [ "c9b0a05a-3f85-4411-943e-9471609ef8bd", "1cb47d15-1e4f-42a0-80aa-485758364d47" ], "Opportunities": [ "be33b827-b4d8-4bee-9d6a-a4885ab57b78", "66e058ff-c905-416f-83c4-338636c37236" ] } } ]