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": "b3fe9732-b23b-48d4-b6c1-0d40709fe6f0",
"SeriesId": "915fbcda-1c37-4d40-97c9-fe571b86ad4d",
"AccessorID": "f03029ca-000a-4ed3-992e-a507eaa52d35",
"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": "e27f74fe-672c-4451-8c12-2b9335fa91b0",
"ScheduledByID": "3e2abf25-1d95-4fed-8a20-b40b4aaf3c73",
"DeletedDates": [
"2026-02-05T07:10:24Z",
"2026-02-05T07:10:24Z"
],
"ClearedDates": [
"2026-02-05T07:10:24Z",
"2026-02-05T07:10:24Z"
],
"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-05T07:10:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-05T07:10:24Z",
"CreateDate": "2026-02-05T07:10:24Z",
"OccurTime": "2026-02-05T07:10:24Z",
"OccurEndTime": "2026-02-05T07:10:24Z",
"StartTime": "2026-02-05T07:10:24Z",
"EndTime": "2026-02-05T07:10:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e03a5d08-807c-4732-aa39-ab1a660a25c3",
"814cb108-68d3-47e1-94cf-7207f3e8fdc8"
],
"Companies": [
"d46ecef5-4626-4442-8686-f8449c2c08ee",
"abf14a70-e2b9-46b5-8c80-0597c52ef0ac"
],
"Groups": [
"853cc012-713d-4dc4-ae63-f8ca7144fb05",
"29e0d983-0655-4e9f-98bd-f3709d4065ac"
],
"Opportunities": [
"72719b60-534a-4031-bc9f-d398146e5ad9",
"481c7910-d3d8-40f0-a2bb-a059e127eba6"
]
}
},
{
"Id": "b3fe9732-b23b-48d4-b6c1-0d40709fe6f0",
"SeriesId": "915fbcda-1c37-4d40-97c9-fe571b86ad4d",
"AccessorID": "f03029ca-000a-4ed3-992e-a507eaa52d35",
"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": "e27f74fe-672c-4451-8c12-2b9335fa91b0",
"ScheduledByID": "3e2abf25-1d95-4fed-8a20-b40b4aaf3c73",
"DeletedDates": [
"2026-02-05T07:10:24Z",
"2026-02-05T07:10:24Z"
],
"ClearedDates": [
"2026-02-05T07:10:24Z",
"2026-02-05T07:10:24Z"
],
"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-05T07:10:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-05T07:10:24Z",
"CreateDate": "2026-02-05T07:10:24Z",
"OccurTime": "2026-02-05T07:10:24Z",
"OccurEndTime": "2026-02-05T07:10:24Z",
"StartTime": "2026-02-05T07:10:24Z",
"EndTime": "2026-02-05T07:10:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e03a5d08-807c-4732-aa39-ab1a660a25c3",
"814cb108-68d3-47e1-94cf-7207f3e8fdc8"
],
"Companies": [
"d46ecef5-4626-4442-8686-f8449c2c08ee",
"abf14a70-e2b9-46b5-8c80-0597c52ef0ac"
],
"Groups": [
"853cc012-713d-4dc4-ae63-f8ca7144fb05",
"29e0d983-0655-4e9f-98bd-f3709d4065ac"
],
"Opportunities": [
"72719b60-534a-4031-bc9f-d398146e5ad9",
"481c7910-d3d8-40f0-a2bb-a059e127eba6"
]
}
}
]