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": "701e0ccf-4b44-46ec-90a2-726afad8634d",
"SeriesId": "57c41038-225b-4a81-a889-f3652509a32d",
"AccessorID": "ffebdaac-29d5-4c9f-8b83-7f00132f2658",
"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": "61b75da6-2efc-4771-86a7-6d5515ea6612",
"ScheduledByID": "876de56f-83a7-48e4-827c-91ebc169370e",
"DeletedDates": [
"2026-02-28T06:30:53Z",
"2026-02-28T06:30:53Z"
],
"ClearedDates": [
"2026-02-28T06:30:53Z",
"2026-02-28T06:30:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T06:30:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T06:30:53Z",
"CreateDate": "2026-02-28T06:30:53Z",
"OccurTime": "2026-02-28T06:30:53Z",
"OccurEndTime": "2026-02-28T06:30:53Z",
"StartTime": "2026-02-28T06:30:53Z",
"EndTime": "2026-02-28T06:30:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"90a262da-0d72-4f2c-8640-ce5ae26bf808",
"8ae025ba-0e4d-43a7-98d7-7ae6dcd12fb7"
],
"Companies": [
"fb90c028-244f-4822-9e3c-b3eac497b7f7",
"119b1509-3357-410a-a6b4-7c4bb015a51b"
],
"Groups": [
"a4b197ac-312c-4aea-9415-47a07bbfbe74",
"e2b7ce27-a0d4-4b9e-b283-876f3633d4b8"
],
"Opportunities": [
"eccdf4c8-be81-4ad9-bdd8-aef82ccb0adc",
"a63a27b4-b138-4035-b457-1665ca2c8060"
]
}
},
{
"Id": "701e0ccf-4b44-46ec-90a2-726afad8634d",
"SeriesId": "57c41038-225b-4a81-a889-f3652509a32d",
"AccessorID": "ffebdaac-29d5-4c9f-8b83-7f00132f2658",
"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": "61b75da6-2efc-4771-86a7-6d5515ea6612",
"ScheduledByID": "876de56f-83a7-48e4-827c-91ebc169370e",
"DeletedDates": [
"2026-02-28T06:30:53Z",
"2026-02-28T06:30:53Z"
],
"ClearedDates": [
"2026-02-28T06:30:53Z",
"2026-02-28T06:30:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T06:30:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T06:30:53Z",
"CreateDate": "2026-02-28T06:30:53Z",
"OccurTime": "2026-02-28T06:30:53Z",
"OccurEndTime": "2026-02-28T06:30:53Z",
"StartTime": "2026-02-28T06:30:53Z",
"EndTime": "2026-02-28T06:30:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"90a262da-0d72-4f2c-8640-ce5ae26bf808",
"8ae025ba-0e4d-43a7-98d7-7ae6dcd12fb7"
],
"Companies": [
"fb90c028-244f-4822-9e3c-b3eac497b7f7",
"119b1509-3357-410a-a6b4-7c4bb015a51b"
],
"Groups": [
"a4b197ac-312c-4aea-9415-47a07bbfbe74",
"e2b7ce27-a0d4-4b9e-b283-876f3633d4b8"
],
"Opportunities": [
"eccdf4c8-be81-4ad9-bdd8-aef82ccb0adc",
"a63a27b4-b138-4035-b457-1665ca2c8060"
]
}
}
]