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": "3b6f3f2e-dc0c-41c3-80de-b37c52adaf0c",
"SeriesId": "2e7c5acc-a744-481a-9545-215b97178e4a",
"AccessorID": "5bdef89b-a047-45f9-9061-906e31f7417b",
"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": "7b4b9937-2c05-4a53-b046-65270cc51735",
"ScheduledByID": "5e2d4edb-4de0-480b-a357-c82e79e4f901",
"DeletedDates": [
"2025-12-18T08:50:24Z",
"2025-12-18T08:50:24Z"
],
"ClearedDates": [
"2025-12-18T08:50:24Z",
"2025-12-18T08:50:24Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-18T08:50:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-18T08:50:24Z",
"CreateDate": "2025-12-18T08:50:24Z",
"OccurTime": "2025-12-18T08:50:24Z",
"OccurEndTime": "2025-12-18T08:50:24Z",
"StartTime": "2025-12-18T08:50:24Z",
"EndTime": "2025-12-18T08:50:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"036f46ef-ba2b-4c4b-a183-ee869050ff02",
"6a329063-5a7d-40ae-a555-8731df3227c7"
],
"Companies": [
"628f4e76-c1e2-4cfa-9224-d17c2cd92fe5",
"f2e4430c-a2e0-4131-9041-ce8dc2568569"
],
"Groups": [
"8c2c3a8a-d313-4888-8788-b24b10a8ffdf",
"9017ff23-17be-4462-986d-86ca73b8bac8"
],
"Opportunities": [
"2d15605f-048e-4260-bf5e-f2fd28301cdc",
"e9df1137-bc2f-4ee0-a05c-171234675830"
]
}
},
{
"Id": "3b6f3f2e-dc0c-41c3-80de-b37c52adaf0c",
"SeriesId": "2e7c5acc-a744-481a-9545-215b97178e4a",
"AccessorID": "5bdef89b-a047-45f9-9061-906e31f7417b",
"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": "7b4b9937-2c05-4a53-b046-65270cc51735",
"ScheduledByID": "5e2d4edb-4de0-480b-a357-c82e79e4f901",
"DeletedDates": [
"2025-12-18T08:50:24Z",
"2025-12-18T08:50:24Z"
],
"ClearedDates": [
"2025-12-18T08:50:24Z",
"2025-12-18T08:50:24Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-18T08:50:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-18T08:50:24Z",
"CreateDate": "2025-12-18T08:50:24Z",
"OccurTime": "2025-12-18T08:50:24Z",
"OccurEndTime": "2025-12-18T08:50:24Z",
"StartTime": "2025-12-18T08:50:24Z",
"EndTime": "2025-12-18T08:50:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"036f46ef-ba2b-4c4b-a183-ee869050ff02",
"6a329063-5a7d-40ae-a555-8731df3227c7"
],
"Companies": [
"628f4e76-c1e2-4cfa-9224-d17c2cd92fe5",
"f2e4430c-a2e0-4131-9041-ce8dc2568569"
],
"Groups": [
"8c2c3a8a-d313-4888-8788-b24b10a8ffdf",
"9017ff23-17be-4462-986d-86ca73b8bac8"
],
"Opportunities": [
"2d15605f-048e-4260-bf5e-f2fd28301cdc",
"e9df1137-bc2f-4ee0-a05c-171234675830"
]
}
}
]