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": "c6d2a9f2-c4c5-4856-86bc-7352f1bd51ff",
"SeriesId": "caf7ab42-1ee1-4f99-8209-9e0bd4f7e031",
"AccessorID": "2efaf88c-f55b-46a3-8926-afe6b20717a4",
"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": "ded95b7e-6586-44a2-9684-66501b0ea087",
"ScheduledByID": "c25fc75b-18f6-4b4e-80fc-8b45aa6bb98e",
"DeletedDates": [
"2025-12-06T15:20:40Z",
"2025-12-06T15:20:40Z"
],
"ClearedDates": [
"2025-12-06T15:20:40Z",
"2025-12-06T15:20:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-06T15:20:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-06T15:20:40Z",
"CreateDate": "2025-12-06T15:20:40Z",
"OccurTime": "2025-12-06T15:20:40Z",
"OccurEndTime": "2025-12-06T15:20:40Z",
"StartTime": "2025-12-06T15:20:40Z",
"EndTime": "2025-12-06T15:20:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dfa857e2-178e-42ca-adc3-ddde54dc1601",
"bf778e8f-9b1d-4b47-9ced-cac304d971af"
],
"Companies": [
"f9163120-66eb-4b65-877f-78c204306711",
"3553915f-05f2-4e01-aa3f-6193628f702e"
],
"Groups": [
"befc36dd-55d1-45e4-a367-016c4270a2ad",
"a58291c5-e19e-40be-8301-a429d7d48cd4"
],
"Opportunities": [
"9437a07e-9d97-4a19-97a9-3dd0c8b5c7cd",
"78aef9c2-b087-482f-bc6f-a0b7bb1c0cb7"
]
}
},
{
"Id": "c6d2a9f2-c4c5-4856-86bc-7352f1bd51ff",
"SeriesId": "caf7ab42-1ee1-4f99-8209-9e0bd4f7e031",
"AccessorID": "2efaf88c-f55b-46a3-8926-afe6b20717a4",
"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": "ded95b7e-6586-44a2-9684-66501b0ea087",
"ScheduledByID": "c25fc75b-18f6-4b4e-80fc-8b45aa6bb98e",
"DeletedDates": [
"2025-12-06T15:20:40Z",
"2025-12-06T15:20:40Z"
],
"ClearedDates": [
"2025-12-06T15:20:40Z",
"2025-12-06T15:20:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-06T15:20:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-06T15:20:40Z",
"CreateDate": "2025-12-06T15:20:40Z",
"OccurTime": "2025-12-06T15:20:40Z",
"OccurEndTime": "2025-12-06T15:20:40Z",
"StartTime": "2025-12-06T15:20:40Z",
"EndTime": "2025-12-06T15:20:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dfa857e2-178e-42ca-adc3-ddde54dc1601",
"bf778e8f-9b1d-4b47-9ced-cac304d971af"
],
"Companies": [
"f9163120-66eb-4b65-877f-78c204306711",
"3553915f-05f2-4e01-aa3f-6193628f702e"
],
"Groups": [
"befc36dd-55d1-45e4-a367-016c4270a2ad",
"a58291c5-e19e-40be-8301-a429d7d48cd4"
],
"Opportunities": [
"9437a07e-9d97-4a19-97a9-3dd0c8b5c7cd",
"78aef9c2-b087-482f-bc6f-a0b7bb1c0cb7"
]
}
}
]