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": "0008a24c-341b-4253-97bc-e485c129779d",
"SeriesId": "265cbd10-8933-4042-be04-05b450253171",
"AccessorID": "316f3250-5aab-4d05-9f56-70cb75bb904b",
"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": "f15886b1-f12f-4714-adcd-4b0655fec57a",
"ScheduledByID": "09719533-3440-4403-a85a-ddc1aa2c4bd8",
"DeletedDates": [
"2026-08-29T12:42:32Z",
"2026-08-29T12:42:32Z"
],
"ClearedDates": [
"2026-08-29T12:42:32Z",
"2026-08-29T12:42:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-29T12:42:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-29T12:42:32Z",
"CreateDate": "2026-08-29T12:42:32Z",
"OccurTime": "2026-08-29T12:42:32Z",
"OccurEndTime": "2026-08-29T12:42:32Z",
"StartTime": "2026-08-29T12:42:32Z",
"EndTime": "2026-08-29T12:42:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ed4fb55b-c777-4e56-bf9f-82afcadb7f37",
"0fbaeea5-7abe-4194-bc04-513de55dba2a"
],
"Companies": [
"fc702236-5e73-407e-af87-46029cd92fa9",
"795cbaad-1cb7-44af-9af1-4ba242f2eb52"
],
"Groups": [
"85da843b-1163-48ce-885a-7bd9747f73c3",
"8043a9c3-a5bc-4714-ace9-4e628b979c16"
],
"Opportunities": [
"7ed16c65-6929-4894-8a2a-74b100cb7885",
"72f76f4d-51fa-4fd7-b079-c4da03711b4b"
]
}
},
{
"Id": "0008a24c-341b-4253-97bc-e485c129779d",
"SeriesId": "265cbd10-8933-4042-be04-05b450253171",
"AccessorID": "316f3250-5aab-4d05-9f56-70cb75bb904b",
"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": "f15886b1-f12f-4714-adcd-4b0655fec57a",
"ScheduledByID": "09719533-3440-4403-a85a-ddc1aa2c4bd8",
"DeletedDates": [
"2026-08-29T12:42:32Z",
"2026-08-29T12:42:32Z"
],
"ClearedDates": [
"2026-08-29T12:42:32Z",
"2026-08-29T12:42:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-29T12:42:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-29T12:42:32Z",
"CreateDate": "2026-08-29T12:42:32Z",
"OccurTime": "2026-08-29T12:42:32Z",
"OccurEndTime": "2026-08-29T12:42:32Z",
"StartTime": "2026-08-29T12:42:32Z",
"EndTime": "2026-08-29T12:42:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ed4fb55b-c777-4e56-bf9f-82afcadb7f37",
"0fbaeea5-7abe-4194-bc04-513de55dba2a"
],
"Companies": [
"fc702236-5e73-407e-af87-46029cd92fa9",
"795cbaad-1cb7-44af-9af1-4ba242f2eb52"
],
"Groups": [
"85da843b-1163-48ce-885a-7bd9747f73c3",
"8043a9c3-a5bc-4714-ace9-4e628b979c16"
],
"Opportunities": [
"7ed16c65-6929-4894-8a2a-74b100cb7885",
"72f76f4d-51fa-4fd7-b079-c4da03711b4b"
]
}
}
]