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": "145b12cd-36a1-4a3e-a983-d959e3628e0a",
"SeriesId": "4473f2ff-01ee-4147-b05d-42a02f9a1ae5",
"AccessorID": "69b43dd0-aac7-42f8-8bc3-80b12ac52261",
"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": "da4b0b7a-2122-45d5-a5a4-271f2f5b8215",
"ScheduledByID": "5fd16f21-7d0e-4b1d-9072-d48d9b09d076",
"DeletedDates": [
"2026-05-01T09:34:46Z",
"2026-05-01T09:34:46Z"
],
"ClearedDates": [
"2026-05-01T09:34:46Z",
"2026-05-01T09:34:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-01T09:34:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-01T09:34:46Z",
"CreateDate": "2026-05-01T09:34:46Z",
"OccurTime": "2026-05-01T09:34:46Z",
"OccurEndTime": "2026-05-01T09:34:46Z",
"StartTime": "2026-05-01T09:34:46Z",
"EndTime": "2026-05-01T09:34:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5063ee6-1098-4963-941d-9ec990e345e3",
"04aa20f4-fa47-4779-9f33-01b08d9e49d9"
],
"Companies": [
"4427cc66-59ce-4a6f-b29b-0e750448b859",
"e6c8a63e-1c16-41cc-b602-3ee96b2a600f"
],
"Groups": [
"30e57afb-d543-478b-9f73-29bc92d8d232",
"513a9976-7eb5-4058-b8b2-8d1e37e3a85d"
],
"Opportunities": [
"f6458caa-2faf-46ea-9930-af27ca1077fd",
"98bc1b75-fbd3-46b7-bc9d-b5445f9fb985"
]
}
},
{
"Id": "145b12cd-36a1-4a3e-a983-d959e3628e0a",
"SeriesId": "4473f2ff-01ee-4147-b05d-42a02f9a1ae5",
"AccessorID": "69b43dd0-aac7-42f8-8bc3-80b12ac52261",
"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": "da4b0b7a-2122-45d5-a5a4-271f2f5b8215",
"ScheduledByID": "5fd16f21-7d0e-4b1d-9072-d48d9b09d076",
"DeletedDates": [
"2026-05-01T09:34:46Z",
"2026-05-01T09:34:46Z"
],
"ClearedDates": [
"2026-05-01T09:34:46Z",
"2026-05-01T09:34:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-01T09:34:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-01T09:34:46Z",
"CreateDate": "2026-05-01T09:34:46Z",
"OccurTime": "2026-05-01T09:34:46Z",
"OccurEndTime": "2026-05-01T09:34:46Z",
"StartTime": "2026-05-01T09:34:46Z",
"EndTime": "2026-05-01T09:34:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5063ee6-1098-4963-941d-9ec990e345e3",
"04aa20f4-fa47-4779-9f33-01b08d9e49d9"
],
"Companies": [
"4427cc66-59ce-4a6f-b29b-0e750448b859",
"e6c8a63e-1c16-41cc-b602-3ee96b2a600f"
],
"Groups": [
"30e57afb-d543-478b-9f73-29bc92d8d232",
"513a9976-7eb5-4058-b8b2-8d1e37e3a85d"
],
"Opportunities": [
"f6458caa-2faf-46ea-9930-af27ca1077fd",
"98bc1b75-fbd3-46b7-bc9d-b5445f9fb985"
]
}
}
]