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": "813c6a1a-c193-4bbc-8aa5-4190fa2b7b91",
"SeriesId": "a9c80e66-57d3-484f-9e1f-0d6cef5f1164",
"AccessorID": "9eb663bb-f846-4a38-b875-0b2d8c542077",
"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": "5dbba9eb-6d5f-496c-8407-0fe0b21df182",
"ScheduledByID": "9a776676-9807-4505-86f8-6e66c4c2efde",
"DeletedDates": [
"2026-01-14T01:14:24Z",
"2026-01-14T01:14:24Z"
],
"ClearedDates": [
"2026-01-14T01:14:24Z",
"2026-01-14T01:14:24Z"
],
"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-14T01:14:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-14T01:14:24Z",
"CreateDate": "2026-01-14T01:14:24Z",
"OccurTime": "2026-01-14T01:14:24Z",
"OccurEndTime": "2026-01-14T01:14:24Z",
"StartTime": "2026-01-14T01:14:24Z",
"EndTime": "2026-01-14T01:14:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bf3c5c45-46da-4fdf-9fa2-a6518863438b",
"6d8a6bc9-8cea-458d-ba1d-47e16ad5fbee"
],
"Companies": [
"883bb069-332a-4da0-a25f-b309d9e0a975",
"54b6aa50-146b-4972-b8ca-9d1bf8912eee"
],
"Groups": [
"140974e7-7e4f-43c5-adf1-3b71d0f765a1",
"15163062-8063-4f81-be3d-26504cc428de"
],
"Opportunities": [
"b55bb0d3-c744-417b-95f6-51446cb353dc",
"567d2dc3-765e-4a90-b268-b15bffecbc9a"
]
}
},
{
"Id": "813c6a1a-c193-4bbc-8aa5-4190fa2b7b91",
"SeriesId": "a9c80e66-57d3-484f-9e1f-0d6cef5f1164",
"AccessorID": "9eb663bb-f846-4a38-b875-0b2d8c542077",
"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": "5dbba9eb-6d5f-496c-8407-0fe0b21df182",
"ScheduledByID": "9a776676-9807-4505-86f8-6e66c4c2efde",
"DeletedDates": [
"2026-01-14T01:14:24Z",
"2026-01-14T01:14:24Z"
],
"ClearedDates": [
"2026-01-14T01:14:24Z",
"2026-01-14T01:14:24Z"
],
"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-14T01:14:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-14T01:14:24Z",
"CreateDate": "2026-01-14T01:14:24Z",
"OccurTime": "2026-01-14T01:14:24Z",
"OccurEndTime": "2026-01-14T01:14:24Z",
"StartTime": "2026-01-14T01:14:24Z",
"EndTime": "2026-01-14T01:14:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bf3c5c45-46da-4fdf-9fa2-a6518863438b",
"6d8a6bc9-8cea-458d-ba1d-47e16ad5fbee"
],
"Companies": [
"883bb069-332a-4da0-a25f-b309d9e0a975",
"54b6aa50-146b-4972-b8ca-9d1bf8912eee"
],
"Groups": [
"140974e7-7e4f-43c5-adf1-3b71d0f765a1",
"15163062-8063-4f81-be3d-26504cc428de"
],
"Opportunities": [
"b55bb0d3-c744-417b-95f6-51446cb353dc",
"567d2dc3-765e-4a90-b268-b15bffecbc9a"
]
}
}
]