GET api/Activities/{id}
Get activity instances of an Activity by ID. Supported Headers: SelectField, IncludeClearedDates, IncludeDeletedDates, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
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": "1e702f13-30ae-423c-91e0-2936e82ac5e4", "SeriesId": "c8ad85ad-b832-4066-b5cc-6d2a9db8bae6", "AccessorID": "0fba67ab-9ae4-4408-bcf0-4b3f3aa341ea", "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": "1766333c-9ba8-47af-ad51-b1597cd1cd53", "ScheduledByID": "f9003e1c-d5f6-4f74-b431-e07b2b82a96f", "DeletedDates": [ "2025-10-21T21:22:30Z", "2025-10-21T21:22:30Z" ], "ClearedDates": [ "2025-10-21T21:22:30Z", "2025-10-21T21:22:30Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-10-21T21:22:30Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-10-21T21:22:30Z", "CreateDate": "2025-10-21T21:22:30Z", "OccurTime": "2025-10-21T21:22:30Z", "OccurEndTime": "2025-10-21T21:22:30Z", "StartTime": "2025-10-21T21:22:30Z", "EndTime": "2025-10-21T21:22:30Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "dd7cfd1a-3da6-42d8-a36c-3389f40d1200", "41bf2caf-7590-4718-86da-a7d5f9e26a97" ], "Companies": [ "f1ec7c2f-90a1-4c82-aa4d-e8ea868ca323", "1fd2f80a-3b3f-4dd4-ae96-73f72460097d" ], "Groups": [ "6aa6b6a0-6828-4b6a-8067-9ae9e3228063", "2a47a214-5d5f-4ca4-a411-02e2c574d2fe" ], "Opportunities": [ "71ba27b3-f66b-4f06-8213-aded1295d4ed", "399f5167-0083-4a17-b1d1-02353276519e" ] } }, { "Id": "1e702f13-30ae-423c-91e0-2936e82ac5e4", "SeriesId": "c8ad85ad-b832-4066-b5cc-6d2a9db8bae6", "AccessorID": "0fba67ab-9ae4-4408-bcf0-4b3f3aa341ea", "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": "1766333c-9ba8-47af-ad51-b1597cd1cd53", "ScheduledByID": "f9003e1c-d5f6-4f74-b431-e07b2b82a96f", "DeletedDates": [ "2025-10-21T21:22:30Z", "2025-10-21T21:22:30Z" ], "ClearedDates": [ "2025-10-21T21:22:30Z", "2025-10-21T21:22:30Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-10-21T21:22:30Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-10-21T21:22:30Z", "CreateDate": "2025-10-21T21:22:30Z", "OccurTime": "2025-10-21T21:22:30Z", "OccurEndTime": "2025-10-21T21:22:30Z", "StartTime": "2025-10-21T21:22:30Z", "EndTime": "2025-10-21T21:22:30Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "dd7cfd1a-3da6-42d8-a36c-3389f40d1200", "41bf2caf-7590-4718-86da-a7d5f9e26a97" ], "Companies": [ "f1ec7c2f-90a1-4c82-aa4d-e8ea868ca323", "1fd2f80a-3b3f-4dd4-ae96-73f72460097d" ], "Groups": [ "6aa6b6a0-6828-4b6a-8067-9ae9e3228063", "2a47a214-5d5f-4ca4-a411-02e2c574d2fe" ], "Opportunities": [ "71ba27b3-f66b-4f06-8213-aded1295d4ed", "399f5167-0083-4a17-b1d1-02353276519e" ] } } ]