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": "aacd36a8-3873-47f0-97cd-8ed7fc1d6adc",
"SeriesId": "821842ad-09b9-4e42-8914-579c7155a07a",
"AccessorID": "f962d31a-af56-4fed-97a6-aaeaaf2ca1da",
"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": "7acc8afc-17b9-4647-b683-ba8d020da196",
"ScheduledByID": "05dbb1ed-5786-4f61-8fb6-1c48876af30b",
"DeletedDates": [
"2025-12-05T05:48:28Z",
"2025-12-05T05:48:28Z"
],
"ClearedDates": [
"2025-12-05T05:48:28Z",
"2025-12-05T05:48:28Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-05T05:48:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-05T05:48:28Z",
"CreateDate": "2025-12-05T05:48:28Z",
"OccurTime": "2025-12-05T05:48:28Z",
"OccurEndTime": "2025-12-05T05:48:28Z",
"StartTime": "2025-12-05T05:48:28Z",
"EndTime": "2025-12-05T05:48:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b3e82c88-4777-4c49-a9be-4b3a36e235a5",
"ce1f45c4-798a-42f5-8b30-0f96e32ef398"
],
"Companies": [
"64441192-f908-4ce7-9525-0989d88ceb0f",
"b7f266d3-4a7d-4d47-af0d-01249524e6eb"
],
"Groups": [
"9abbb836-8a37-4925-be64-aae14957b62e",
"9a44369d-5ffc-4b06-8fbe-711c9afb1b98"
],
"Opportunities": [
"8f32a50e-7e32-43fa-a90c-a48726089f55",
"5531d417-ab05-4c43-8d3f-246bd464c213"
]
}
},
{
"Id": "aacd36a8-3873-47f0-97cd-8ed7fc1d6adc",
"SeriesId": "821842ad-09b9-4e42-8914-579c7155a07a",
"AccessorID": "f962d31a-af56-4fed-97a6-aaeaaf2ca1da",
"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": "7acc8afc-17b9-4647-b683-ba8d020da196",
"ScheduledByID": "05dbb1ed-5786-4f61-8fb6-1c48876af30b",
"DeletedDates": [
"2025-12-05T05:48:28Z",
"2025-12-05T05:48:28Z"
],
"ClearedDates": [
"2025-12-05T05:48:28Z",
"2025-12-05T05:48:28Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-05T05:48:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-05T05:48:28Z",
"CreateDate": "2025-12-05T05:48:28Z",
"OccurTime": "2025-12-05T05:48:28Z",
"OccurEndTime": "2025-12-05T05:48:28Z",
"StartTime": "2025-12-05T05:48:28Z",
"EndTime": "2025-12-05T05:48:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b3e82c88-4777-4c49-a9be-4b3a36e235a5",
"ce1f45c4-798a-42f5-8b30-0f96e32ef398"
],
"Companies": [
"64441192-f908-4ce7-9525-0989d88ceb0f",
"b7f266d3-4a7d-4d47-af0d-01249524e6eb"
],
"Groups": [
"9abbb836-8a37-4925-be64-aae14957b62e",
"9a44369d-5ffc-4b06-8fbe-711c9afb1b98"
],
"Opportunities": [
"8f32a50e-7e32-43fa-a90c-a48726089f55",
"5531d417-ab05-4c43-8d3f-246bd464c213"
]
}
}
]