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": "6634525c-82c1-40f3-b8b3-9181563e4556",
"SeriesId": "adc713a1-3cb4-4d59-abba-161c7d732ec3",
"AccessorID": "6a2bb3c4-bb5f-4c32-9ca6-c27d3de3bcdf",
"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": "9876f3f1-67ae-462a-8333-04710e7a9e08",
"ScheduledByID": "3ad21ff1-0595-4726-ba2c-3f4704b42c21",
"DeletedDates": [
"2026-06-16T13:45:59Z",
"2026-06-16T13:45:59Z"
],
"ClearedDates": [
"2026-06-16T13:45:59Z",
"2026-06-16T13:45:59Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-16T13:45:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-16T13:45:59Z",
"CreateDate": "2026-06-16T13:45:59Z",
"OccurTime": "2026-06-16T13:45:59Z",
"OccurEndTime": "2026-06-16T13:45:59Z",
"StartTime": "2026-06-16T13:45:59Z",
"EndTime": "2026-06-16T13:45:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b917ebf7-eafa-4b87-ab06-ee87016a8395",
"17f69d0e-4317-4013-a412-b84775a8a292"
],
"Companies": [
"84f0462b-aecd-4a99-95f3-b11516926665",
"f70a5b80-294a-463b-a091-1d7297310072"
],
"Groups": [
"d5af3260-6f45-4fb7-9895-49761b3669c0",
"4e3d1d6a-c386-4d97-a52b-e4df74b43533"
],
"Opportunities": [
"8c4aefe0-ca66-49e5-9313-054a4c2cd7f4",
"8e3bad44-27c7-46ed-9cbc-5473a0dbf909"
]
}
},
{
"Id": "6634525c-82c1-40f3-b8b3-9181563e4556",
"SeriesId": "adc713a1-3cb4-4d59-abba-161c7d732ec3",
"AccessorID": "6a2bb3c4-bb5f-4c32-9ca6-c27d3de3bcdf",
"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": "9876f3f1-67ae-462a-8333-04710e7a9e08",
"ScheduledByID": "3ad21ff1-0595-4726-ba2c-3f4704b42c21",
"DeletedDates": [
"2026-06-16T13:45:59Z",
"2026-06-16T13:45:59Z"
],
"ClearedDates": [
"2026-06-16T13:45:59Z",
"2026-06-16T13:45:59Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-16T13:45:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-16T13:45:59Z",
"CreateDate": "2026-06-16T13:45:59Z",
"OccurTime": "2026-06-16T13:45:59Z",
"OccurEndTime": "2026-06-16T13:45:59Z",
"StartTime": "2026-06-16T13:45:59Z",
"EndTime": "2026-06-16T13:45:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b917ebf7-eafa-4b87-ab06-ee87016a8395",
"17f69d0e-4317-4013-a412-b84775a8a292"
],
"Companies": [
"84f0462b-aecd-4a99-95f3-b11516926665",
"f70a5b80-294a-463b-a091-1d7297310072"
],
"Groups": [
"d5af3260-6f45-4fb7-9895-49761b3669c0",
"4e3d1d6a-c386-4d97-a52b-e4df74b43533"
],
"Opportunities": [
"8c4aefe0-ca66-49e5-9313-054a4c2cd7f4",
"8e3bad44-27c7-46ed-9cbc-5473a0dbf909"
]
}
}
]