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": "a0a6e16e-f7ce-418e-a4f4-69e963ce1d8e", "SeriesId": "d721d5bc-0534-4f96-8369-3ed1a302102f", "AccessorID": "30064bfc-4f35-4554-a37c-c92b52242b97", "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": "c14fbe05-a5c9-40d9-83db-a0a95b089fd2", "ScheduledByID": "49ef891a-0dcc-4f71-ac41-7a754d92b8b7", "DeletedDates": [ "2025-08-21T15:30:43Z", "2025-08-21T15:30:43Z" ], "ClearedDates": [ "2025-08-21T15:30:43Z", "2025-08-21T15:30: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-08-21T15:30:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-08-21T15:30:43Z", "CreateDate": "2025-08-21T15:30:43Z", "OccurTime": "2025-08-21T15:30:43Z", "OccurEndTime": "2025-08-21T15:30:43Z", "StartTime": "2025-08-21T15:30:43Z", "EndTime": "2025-08-21T15:30:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c1aca1f6-ec78-4ead-9346-28bff4529b8b", "d875be43-0f20-4ab3-b5b9-d73ad934fec0" ], "Companies": [ "f18ee164-ae7b-4e20-b05b-57ad0f8dda4f", "c8365c57-4a18-4fdc-9d59-fb0e614ebd1c" ], "Groups": [ "4b07b82e-4d45-4d50-b958-e923b7ed824e", "550831d9-f918-4283-97c9-df0c0d5f509e" ], "Opportunities": [ "12ff92ec-d6f4-4a66-ae04-f2a08e4ef324", "8ff8e531-f870-42e3-a1a7-b952de000493" ] } }, { "Id": "a0a6e16e-f7ce-418e-a4f4-69e963ce1d8e", "SeriesId": "d721d5bc-0534-4f96-8369-3ed1a302102f", "AccessorID": "30064bfc-4f35-4554-a37c-c92b52242b97", "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": "c14fbe05-a5c9-40d9-83db-a0a95b089fd2", "ScheduledByID": "49ef891a-0dcc-4f71-ac41-7a754d92b8b7", "DeletedDates": [ "2025-08-21T15:30:43Z", "2025-08-21T15:30:43Z" ], "ClearedDates": [ "2025-08-21T15:30:43Z", "2025-08-21T15:30: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-08-21T15:30:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-08-21T15:30:43Z", "CreateDate": "2025-08-21T15:30:43Z", "OccurTime": "2025-08-21T15:30:43Z", "OccurEndTime": "2025-08-21T15:30:43Z", "StartTime": "2025-08-21T15:30:43Z", "EndTime": "2025-08-21T15:30:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c1aca1f6-ec78-4ead-9346-28bff4529b8b", "d875be43-0f20-4ab3-b5b9-d73ad934fec0" ], "Companies": [ "f18ee164-ae7b-4e20-b05b-57ad0f8dda4f", "c8365c57-4a18-4fdc-9d59-fb0e614ebd1c" ], "Groups": [ "4b07b82e-4d45-4d50-b958-e923b7ed824e", "550831d9-f918-4283-97c9-df0c0d5f509e" ], "Opportunities": [ "12ff92ec-d6f4-4a66-ae04-f2a08e4ef324", "8ff8e531-f870-42e3-a1a7-b952de000493" ] } } ]