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": "900d3afa-b610-4226-877f-fd2a36e39bed",
"SeriesId": "1fe463bf-8923-4d45-8437-d34b10eb0457",
"AccessorID": "51f3870b-a1a6-43a7-9ce2-4521c18dfcdb",
"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": "fe15fba2-e106-4e57-8228-a4bd85294137",
"ScheduledByID": "6bd11ee3-fd50-4cb7-894f-8aeca0e62144",
"DeletedDates": [
"2026-03-05T04:34:11Z",
"2026-03-05T04:34:11Z"
],
"ClearedDates": [
"2026-03-05T04:34:11Z",
"2026-03-05T04:34:11Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-05T04:34:11Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-05T04:34:11Z",
"CreateDate": "2026-03-05T04:34:11Z",
"OccurTime": "2026-03-05T04:34:11Z",
"OccurEndTime": "2026-03-05T04:34:11Z",
"StartTime": "2026-03-05T04:34:11Z",
"EndTime": "2026-03-05T04:34:11Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f4c486ea-1f2a-4f55-9ceb-e6bcd6c23ac7",
"522a855b-bdbc-46bb-a52b-4535b346d500"
],
"Companies": [
"a1330f66-f70a-42c4-87d6-406729238d77",
"b78d4607-4864-43d2-ba0b-c8a8cba3b5cc"
],
"Groups": [
"cabe01b9-b75f-4828-95a2-f4526647acb0",
"2fc223d3-78da-42fb-ac5b-bb9e39cb1ed1"
],
"Opportunities": [
"09fda47b-3049-4761-944c-0d6452a1eea9",
"4a15c6b9-f0ea-4398-98e0-f3845739df36"
]
}
},
{
"Id": "900d3afa-b610-4226-877f-fd2a36e39bed",
"SeriesId": "1fe463bf-8923-4d45-8437-d34b10eb0457",
"AccessorID": "51f3870b-a1a6-43a7-9ce2-4521c18dfcdb",
"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": "fe15fba2-e106-4e57-8228-a4bd85294137",
"ScheduledByID": "6bd11ee3-fd50-4cb7-894f-8aeca0e62144",
"DeletedDates": [
"2026-03-05T04:34:11Z",
"2026-03-05T04:34:11Z"
],
"ClearedDates": [
"2026-03-05T04:34:11Z",
"2026-03-05T04:34:11Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-05T04:34:11Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-05T04:34:11Z",
"CreateDate": "2026-03-05T04:34:11Z",
"OccurTime": "2026-03-05T04:34:11Z",
"OccurEndTime": "2026-03-05T04:34:11Z",
"StartTime": "2026-03-05T04:34:11Z",
"EndTime": "2026-03-05T04:34:11Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f4c486ea-1f2a-4f55-9ceb-e6bcd6c23ac7",
"522a855b-bdbc-46bb-a52b-4535b346d500"
],
"Companies": [
"a1330f66-f70a-42c4-87d6-406729238d77",
"b78d4607-4864-43d2-ba0b-c8a8cba3b5cc"
],
"Groups": [
"cabe01b9-b75f-4828-95a2-f4526647acb0",
"2fc223d3-78da-42fb-ac5b-bb9e39cb1ed1"
],
"Opportunities": [
"09fda47b-3049-4761-944c-0d6452a1eea9",
"4a15c6b9-f0ea-4398-98e0-f3845739df36"
]
}
}
]