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 Activity| Name | 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": "33c97921-9817-4c4d-81d1-73b8660accb0",
"SeriesId": "3dd81213-f5a8-41e6-8d66-1a9128118611",
"AccessorID": "bfc1cec8-51dc-4381-b478-b5cab4a13bb1",
"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": "a836785e-071d-41df-9508-ecea36559cd3",
"ScheduledByID": "ca7aa439-0d6b-416c-a7e1-f941910f73f8",
"DeletedDates": [
"2025-11-29T05:29:45Z",
"2025-11-29T05:29:45Z"
],
"ClearedDates": [
"2025-11-29T05:29:45Z",
"2025-11-29T05:29:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-29T05:29:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-29T05:29:45Z",
"CreateDate": "2025-11-29T05:29:45Z",
"OccurTime": "2025-11-29T05:29:45Z",
"OccurEndTime": "2025-11-29T05:29:45Z",
"StartTime": "2025-11-29T05:29:45Z",
"EndTime": "2025-11-29T05:29:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"06d78573-7dfc-47de-9cde-695737e87c4c",
"f6f65007-ea77-45ac-a68d-d488185285ce"
],
"Companies": [
"93f1b8bc-8a70-408c-a967-caa8fe2b7c9b",
"16e21e3f-5857-4b8d-b13c-5ce3b2b2aeb4"
],
"Groups": [
"9c4f7dd9-664c-449a-a92b-e2d8b2cc49b1",
"c37c7c5e-48c3-46e5-a04b-e0aa1edd8cf8"
],
"Opportunities": [
"45b89dee-e392-4bc3-a86c-1bb5c4ae994d",
"fc994537-854c-4628-b507-adf33507325b"
]
}
},
{
"Id": "33c97921-9817-4c4d-81d1-73b8660accb0",
"SeriesId": "3dd81213-f5a8-41e6-8d66-1a9128118611",
"AccessorID": "bfc1cec8-51dc-4381-b478-b5cab4a13bb1",
"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": "a836785e-071d-41df-9508-ecea36559cd3",
"ScheduledByID": "ca7aa439-0d6b-416c-a7e1-f941910f73f8",
"DeletedDates": [
"2025-11-29T05:29:45Z",
"2025-11-29T05:29:45Z"
],
"ClearedDates": [
"2025-11-29T05:29:45Z",
"2025-11-29T05:29:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-29T05:29:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-29T05:29:45Z",
"CreateDate": "2025-11-29T05:29:45Z",
"OccurTime": "2025-11-29T05:29:45Z",
"OccurEndTime": "2025-11-29T05:29:45Z",
"StartTime": "2025-11-29T05:29:45Z",
"EndTime": "2025-11-29T05:29:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"06d78573-7dfc-47de-9cde-695737e87c4c",
"f6f65007-ea77-45ac-a68d-d488185285ce"
],
"Companies": [
"93f1b8bc-8a70-408c-a967-caa8fe2b7c9b",
"16e21e3f-5857-4b8d-b13c-5ce3b2b2aeb4"
],
"Groups": [
"9c4f7dd9-664c-449a-a92b-e2d8b2cc49b1",
"c37c7c5e-48c3-46e5-a04b-e0aa1edd8cf8"
],
"Opportunities": [
"45b89dee-e392-4bc3-a86c-1bb5c4ae994d",
"fc994537-854c-4628-b507-adf33507325b"
]
}
}
]