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": "147b1297-ca9d-4410-99b8-8538084a8003",
"SeriesId": "85f88701-e044-437b-98be-2cc1229ce0bd",
"AccessorID": "a1036802-352f-416b-8e2e-faa45c16ec48",
"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": "07150dbc-ff4a-4adc-ab4f-281dafe7cc9e",
"ScheduledByID": "afc28c2b-5e4a-4194-9c17-0e90cfa5a738",
"DeletedDates": [
"2026-01-05T00:01:48Z",
"2026-01-05T00:01:48Z"
],
"ClearedDates": [
"2026-01-05T00:01:48Z",
"2026-01-05T00:01:48Z"
],
"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-05T00:01:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-05T00:01:48Z",
"CreateDate": "2026-01-05T00:01:48Z",
"OccurTime": "2026-01-05T00:01:48Z",
"OccurEndTime": "2026-01-05T00:01:48Z",
"StartTime": "2026-01-05T00:01:48Z",
"EndTime": "2026-01-05T00:01:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"07e48cb0-1d4e-40f6-93b0-76986a3351d8",
"37aa5ed3-5535-46e6-9895-5832e61fc7d5"
],
"Companies": [
"e0e8ece6-07b0-42b7-be70-90f5881731e2",
"638fb6a8-503b-42b2-9230-8c48afb93f7c"
],
"Groups": [
"ad7ff932-babd-4640-b8f2-5530eba35bcb",
"3affca1f-6a9e-424f-a951-1a9898e40ed6"
],
"Opportunities": [
"2f6a65dd-c649-4866-99ae-3d23cef78174",
"238177f2-3b59-46d9-8313-cc0856a78bc9"
]
}
},
{
"Id": "147b1297-ca9d-4410-99b8-8538084a8003",
"SeriesId": "85f88701-e044-437b-98be-2cc1229ce0bd",
"AccessorID": "a1036802-352f-416b-8e2e-faa45c16ec48",
"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": "07150dbc-ff4a-4adc-ab4f-281dafe7cc9e",
"ScheduledByID": "afc28c2b-5e4a-4194-9c17-0e90cfa5a738",
"DeletedDates": [
"2026-01-05T00:01:48Z",
"2026-01-05T00:01:48Z"
],
"ClearedDates": [
"2026-01-05T00:01:48Z",
"2026-01-05T00:01:48Z"
],
"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-05T00:01:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-05T00:01:48Z",
"CreateDate": "2026-01-05T00:01:48Z",
"OccurTime": "2026-01-05T00:01:48Z",
"OccurEndTime": "2026-01-05T00:01:48Z",
"StartTime": "2026-01-05T00:01:48Z",
"EndTime": "2026-01-05T00:01:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"07e48cb0-1d4e-40f6-93b0-76986a3351d8",
"37aa5ed3-5535-46e6-9895-5832e61fc7d5"
],
"Companies": [
"e0e8ece6-07b0-42b7-be70-90f5881731e2",
"638fb6a8-503b-42b2-9230-8c48afb93f7c"
],
"Groups": [
"ad7ff932-babd-4640-b8f2-5530eba35bcb",
"3affca1f-6a9e-424f-a951-1a9898e40ed6"
],
"Opportunities": [
"2f6a65dd-c649-4866-99ae-3d23cef78174",
"238177f2-3b59-46d9-8313-cc0856a78bc9"
]
}
}
]