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": "6d385be5-6d22-403c-b68e-c8894143926b",
"SeriesId": "828ac532-e210-4fe2-b14b-c142f78c7a74",
"AccessorID": "f9cd7f92-27c8-4248-a07c-15cf41bdf687",
"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": "61eff5b0-9367-4cfc-9126-0b050865c7ad",
"ScheduledByID": "aea6ad91-f450-427e-b94a-925112f8faf4",
"DeletedDates": [
"2025-12-28T13:56:03Z",
"2025-12-28T13:56:03Z"
],
"ClearedDates": [
"2025-12-28T13:56:03Z",
"2025-12-28T13:56:03Z"
],
"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-28T13:56:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-28T13:56:03Z",
"CreateDate": "2025-12-28T13:56:03Z",
"OccurTime": "2025-12-28T13:56:03Z",
"OccurEndTime": "2025-12-28T13:56:03Z",
"StartTime": "2025-12-28T13:56:03Z",
"EndTime": "2025-12-28T13:56:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"665b3ad5-3e9e-4221-8474-178648140c69",
"349994a5-bbe8-42e6-8910-b2803db7884c"
],
"Companies": [
"2ad58e63-2162-4d2a-9f70-6c29563cf265",
"d523a18e-7cf0-4317-838f-912913b755b5"
],
"Groups": [
"4b5ef227-c14a-47a4-b891-6402c21e9431",
"b65a87b1-4328-4109-93f4-05eaf8491683"
],
"Opportunities": [
"60e75887-3770-4089-b8bd-41fbe7944e86",
"04f40aef-6147-47bf-8a88-82be3db46072"
]
}
},
{
"Id": "6d385be5-6d22-403c-b68e-c8894143926b",
"SeriesId": "828ac532-e210-4fe2-b14b-c142f78c7a74",
"AccessorID": "f9cd7f92-27c8-4248-a07c-15cf41bdf687",
"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": "61eff5b0-9367-4cfc-9126-0b050865c7ad",
"ScheduledByID": "aea6ad91-f450-427e-b94a-925112f8faf4",
"DeletedDates": [
"2025-12-28T13:56:03Z",
"2025-12-28T13:56:03Z"
],
"ClearedDates": [
"2025-12-28T13:56:03Z",
"2025-12-28T13:56:03Z"
],
"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-28T13:56:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-28T13:56:03Z",
"CreateDate": "2025-12-28T13:56:03Z",
"OccurTime": "2025-12-28T13:56:03Z",
"OccurEndTime": "2025-12-28T13:56:03Z",
"StartTime": "2025-12-28T13:56:03Z",
"EndTime": "2025-12-28T13:56:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"665b3ad5-3e9e-4221-8474-178648140c69",
"349994a5-bbe8-42e6-8910-b2803db7884c"
],
"Companies": [
"2ad58e63-2162-4d2a-9f70-6c29563cf265",
"d523a18e-7cf0-4317-838f-912913b755b5"
],
"Groups": [
"4b5ef227-c14a-47a4-b891-6402c21e9431",
"b65a87b1-4328-4109-93f4-05eaf8491683"
],
"Opportunities": [
"60e75887-3770-4089-b8bd-41fbe7944e86",
"04f40aef-6147-47bf-8a88-82be3db46072"
]
}
}
]