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": "2e114492-be43-4ed6-bfac-37997d68fcb5",
"SeriesId": "11a9edb1-a386-4554-a08e-a91c297a57eb",
"AccessorID": "e206c634-7e57-4ca1-9270-4a6ec040c0ad",
"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": "27f0b082-236c-4a70-aa21-39e61926a6ed",
"ScheduledByID": "3e37ea3b-0444-425c-a8d0-a04601e9264d",
"DeletedDates": [
"2026-01-29T13:21:13Z",
"2026-01-29T13:21:13Z"
],
"ClearedDates": [
"2026-01-29T13:21:13Z",
"2026-01-29T13:21:13Z"
],
"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-29T13:21:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-29T13:21:13Z",
"CreateDate": "2026-01-29T13:21:13Z",
"OccurTime": "2026-01-29T13:21:13Z",
"OccurEndTime": "2026-01-29T13:21:13Z",
"StartTime": "2026-01-29T13:21:13Z",
"EndTime": "2026-01-29T13:21:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"929f17a0-dc7f-42d5-ae51-b11b69e5c87d",
"7954e124-7776-4f70-9d39-ab62f56f5173"
],
"Companies": [
"7226a501-eecf-4cfb-8d8d-addb1d0cc0e4",
"61cedcc7-7194-412c-9fc0-67aa5498a623"
],
"Groups": [
"521621b1-2ef3-44ef-b960-48f572548e6b",
"0d0b1046-ed1c-4475-a0bc-16d96b903b02"
],
"Opportunities": [
"184a84bc-dcc4-45ef-9229-fe53642064f2",
"efe9fae5-87a3-473f-b4c7-b97f1e337c09"
]
}
},
{
"Id": "2e114492-be43-4ed6-bfac-37997d68fcb5",
"SeriesId": "11a9edb1-a386-4554-a08e-a91c297a57eb",
"AccessorID": "e206c634-7e57-4ca1-9270-4a6ec040c0ad",
"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": "27f0b082-236c-4a70-aa21-39e61926a6ed",
"ScheduledByID": "3e37ea3b-0444-425c-a8d0-a04601e9264d",
"DeletedDates": [
"2026-01-29T13:21:13Z",
"2026-01-29T13:21:13Z"
],
"ClearedDates": [
"2026-01-29T13:21:13Z",
"2026-01-29T13:21:13Z"
],
"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-29T13:21:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-29T13:21:13Z",
"CreateDate": "2026-01-29T13:21:13Z",
"OccurTime": "2026-01-29T13:21:13Z",
"OccurEndTime": "2026-01-29T13:21:13Z",
"StartTime": "2026-01-29T13:21:13Z",
"EndTime": "2026-01-29T13:21:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"929f17a0-dc7f-42d5-ae51-b11b69e5c87d",
"7954e124-7776-4f70-9d39-ab62f56f5173"
],
"Companies": [
"7226a501-eecf-4cfb-8d8d-addb1d0cc0e4",
"61cedcc7-7194-412c-9fc0-67aa5498a623"
],
"Groups": [
"521621b1-2ef3-44ef-b960-48f572548e6b",
"0d0b1046-ed1c-4475-a0bc-16d96b903b02"
],
"Opportunities": [
"184a84bc-dcc4-45ef-9229-fe53642064f2",
"efe9fae5-87a3-473f-b4c7-b97f1e337c09"
]
}
}
]