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": "e6dc7fac-a420-4613-a8ab-1b149137ef46", "SeriesId": "42c32a7e-c7f0-4310-aa2a-32f56c128030", "AccessorID": "329ef79f-6213-4b6a-914f-cc7038cf33e0", "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": "c0cc1635-b49f-4ac7-a66d-25ba89c637ae", "ScheduledByID": "73db81ae-e68b-482d-a786-4f3afe6ae28d", "DeletedDates": [ "2025-04-19T01:23:17Z", "2025-04-19T01:23:17Z" ], "ClearedDates": [ "2025-04-19T01:23:17Z", "2025-04-19T01:23:17Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-04-19T01:23:17Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-04-19T01:23:17Z", "CreateDate": "2025-04-19T01:23:17Z", "OccurTime": "2025-04-19T01:23:17Z", "OccurEndTime": "2025-04-19T01:23:17Z", "StartTime": "2025-04-19T01:23:17Z", "EndTime": "2025-04-19T01:23:17Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "726832f9-d2f0-48cb-9500-37485f7a7bc7", "4563f633-cce4-4eeb-a827-59b4762490e7" ], "Companies": [ "256e33ca-c6cc-48f9-89ef-8971c94039da", "faf32f64-9011-45cc-8fff-39eb42772085" ], "Groups": [ "e829b65e-dacc-4265-9e35-1d256a1f76c7", "a9ffc832-4892-42c1-bd55-f0161eb4d0b1" ], "Opportunities": [ "daacd4e9-3374-475e-94b3-150f1491c54d", "e0decc95-f0cd-487d-93f0-c977416569a6" ] } }, { "Id": "e6dc7fac-a420-4613-a8ab-1b149137ef46", "SeriesId": "42c32a7e-c7f0-4310-aa2a-32f56c128030", "AccessorID": "329ef79f-6213-4b6a-914f-cc7038cf33e0", "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": "c0cc1635-b49f-4ac7-a66d-25ba89c637ae", "ScheduledByID": "73db81ae-e68b-482d-a786-4f3afe6ae28d", "DeletedDates": [ "2025-04-19T01:23:17Z", "2025-04-19T01:23:17Z" ], "ClearedDates": [ "2025-04-19T01:23:17Z", "2025-04-19T01:23:17Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2025-04-19T01:23:17Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2025-04-19T01:23:17Z", "CreateDate": "2025-04-19T01:23:17Z", "OccurTime": "2025-04-19T01:23:17Z", "OccurEndTime": "2025-04-19T01:23:17Z", "StartTime": "2025-04-19T01:23:17Z", "EndTime": "2025-04-19T01:23:17Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "726832f9-d2f0-48cb-9500-37485f7a7bc7", "4563f633-cce4-4eeb-a827-59b4762490e7" ], "Companies": [ "256e33ca-c6cc-48f9-89ef-8971c94039da", "faf32f64-9011-45cc-8fff-39eb42772085" ], "Groups": [ "e829b65e-dacc-4265-9e35-1d256a1f76c7", "a9ffc832-4892-42c1-bd55-f0161eb4d0b1" ], "Opportunities": [ "daacd4e9-3374-475e-94b3-150f1491c54d", "e0decc95-f0cd-487d-93f0-c977416569a6" ] } } ]