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": "bfeb6d19-88af-4287-857a-de9c12d69abc",
"SeriesId": "4a896d82-ac92-47d4-8630-a9010cdd6ab0",
"AccessorID": "48441a70-58a8-4efa-b969-6978f3e0bf8b",
"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": "ec2ad099-85a3-4e1e-8965-807e5ade2c3d",
"ScheduledByID": "aea7857b-c1c6-49b6-ba84-bbddf2f15155",
"DeletedDates": [
"2026-04-29T19:42:37Z",
"2026-04-29T19:42:37Z"
],
"ClearedDates": [
"2026-04-29T19:42:37Z",
"2026-04-29T19:42:37Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-29T19:42:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-29T19:42:37Z",
"CreateDate": "2026-04-29T19:42:37Z",
"OccurTime": "2026-04-29T19:42:37Z",
"OccurEndTime": "2026-04-29T19:42:37Z",
"StartTime": "2026-04-29T19:42:37Z",
"EndTime": "2026-04-29T19:42:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f120b551-3586-4e87-a8bf-fa604bac6a24",
"eaf8c2c5-7aa2-42e0-b466-dd753141748d"
],
"Companies": [
"0e3a0778-66dd-4938-bf46-fbd3dcd7888a",
"a0929656-21d0-493d-a566-f1f9ef359fd6"
],
"Groups": [
"a1c89d7e-9ee3-438a-b9db-a048ddbb2f2c",
"84b27885-abb7-434f-8cf4-2abfaf5a29dc"
],
"Opportunities": [
"6a77a3f4-95e1-4608-8e83-f097847f3beb",
"90053ee5-16b2-4ee9-8dab-162eb7097c39"
]
}
},
{
"Id": "bfeb6d19-88af-4287-857a-de9c12d69abc",
"SeriesId": "4a896d82-ac92-47d4-8630-a9010cdd6ab0",
"AccessorID": "48441a70-58a8-4efa-b969-6978f3e0bf8b",
"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": "ec2ad099-85a3-4e1e-8965-807e5ade2c3d",
"ScheduledByID": "aea7857b-c1c6-49b6-ba84-bbddf2f15155",
"DeletedDates": [
"2026-04-29T19:42:37Z",
"2026-04-29T19:42:37Z"
],
"ClearedDates": [
"2026-04-29T19:42:37Z",
"2026-04-29T19:42:37Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-29T19:42:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-29T19:42:37Z",
"CreateDate": "2026-04-29T19:42:37Z",
"OccurTime": "2026-04-29T19:42:37Z",
"OccurEndTime": "2026-04-29T19:42:37Z",
"StartTime": "2026-04-29T19:42:37Z",
"EndTime": "2026-04-29T19:42:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f120b551-3586-4e87-a8bf-fa604bac6a24",
"eaf8c2c5-7aa2-42e0-b466-dd753141748d"
],
"Companies": [
"0e3a0778-66dd-4938-bf46-fbd3dcd7888a",
"a0929656-21d0-493d-a566-f1f9ef359fd6"
],
"Groups": [
"a1c89d7e-9ee3-438a-b9db-a048ddbb2f2c",
"84b27885-abb7-434f-8cf4-2abfaf5a29dc"
],
"Opportunities": [
"6a77a3f4-95e1-4608-8e83-f097847f3beb",
"90053ee5-16b2-4ee9-8dab-162eb7097c39"
]
}
}
]