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": "56d695df-715d-452d-b140-11fe2cd3560b",
"SeriesId": "aa99498e-dd36-4953-a20a-dd9176ecbdda",
"AccessorID": "1945a78e-59ff-47e2-9d31-8f7a1b14736c",
"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": "d4ef28a6-30a3-4328-80cc-30cac0022e06",
"ScheduledByID": "5fe116b8-2ed1-48a3-8d35-1c9243fab189",
"DeletedDates": [
"2026-01-25T07:47:07Z",
"2026-01-25T07:47:07Z"
],
"ClearedDates": [
"2026-01-25T07:47:07Z",
"2026-01-25T07:47:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-25T07:47:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-25T07:47:07Z",
"CreateDate": "2026-01-25T07:47:07Z",
"OccurTime": "2026-01-25T07:47:07Z",
"OccurEndTime": "2026-01-25T07:47:07Z",
"StartTime": "2026-01-25T07:47:07Z",
"EndTime": "2026-01-25T07:47:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"afea2844-828e-43fb-9026-37761ba5dc6c",
"b25f757d-eb33-45f6-bb8a-433b2aaf7c11"
],
"Companies": [
"407c6f3a-f6d3-4271-b5b2-b836ee8a14c9",
"c732c483-0b5a-4897-8e8e-9a4a1f406411"
],
"Groups": [
"49c5dab3-c103-48e3-adb0-cce80a2681b2",
"17009fa1-582a-465a-92f3-3ae574017623"
],
"Opportunities": [
"67e09195-84da-4a6e-b7ae-722beb10407b",
"ad01d352-c588-4d78-b35a-8d2861844909"
]
}
},
{
"Id": "56d695df-715d-452d-b140-11fe2cd3560b",
"SeriesId": "aa99498e-dd36-4953-a20a-dd9176ecbdda",
"AccessorID": "1945a78e-59ff-47e2-9d31-8f7a1b14736c",
"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": "d4ef28a6-30a3-4328-80cc-30cac0022e06",
"ScheduledByID": "5fe116b8-2ed1-48a3-8d35-1c9243fab189",
"DeletedDates": [
"2026-01-25T07:47:07Z",
"2026-01-25T07:47:07Z"
],
"ClearedDates": [
"2026-01-25T07:47:07Z",
"2026-01-25T07:47:07Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-25T07:47:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-25T07:47:07Z",
"CreateDate": "2026-01-25T07:47:07Z",
"OccurTime": "2026-01-25T07:47:07Z",
"OccurEndTime": "2026-01-25T07:47:07Z",
"StartTime": "2026-01-25T07:47:07Z",
"EndTime": "2026-01-25T07:47:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"afea2844-828e-43fb-9026-37761ba5dc6c",
"b25f757d-eb33-45f6-bb8a-433b2aaf7c11"
],
"Companies": [
"407c6f3a-f6d3-4271-b5b2-b836ee8a14c9",
"c732c483-0b5a-4897-8e8e-9a4a1f406411"
],
"Groups": [
"49c5dab3-c103-48e3-adb0-cce80a2681b2",
"17009fa1-582a-465a-92f3-3ae574017623"
],
"Opportunities": [
"67e09195-84da-4a6e-b7ae-722beb10407b",
"ad01d352-c588-4d78-b35a-8d2861844909"
]
}
}
]