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": "268a93f1-f4ea-4a45-b791-90ab371fd4cd",
"SeriesId": "0cf2d52f-25b7-4e9d-9f11-5b0bbced105f",
"AccessorID": "64d734eb-4b59-4a4a-8842-3a7cd9f4b2f2",
"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": "69fb9cea-c72c-4af2-8000-b23fa6fbd53a",
"ScheduledByID": "6fd43b13-ce26-4f65-bb26-7c538d6118ed",
"DeletedDates": [
"2025-11-12T02:13:46Z",
"2025-11-12T02:13:46Z"
],
"ClearedDates": [
"2025-11-12T02:13:46Z",
"2025-11-12T02:13:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-12T02:13:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-12T02:13:46Z",
"CreateDate": "2025-11-12T02:13:46Z",
"OccurTime": "2025-11-12T02:13:46Z",
"OccurEndTime": "2025-11-12T02:13:46Z",
"StartTime": "2025-11-12T02:13:46Z",
"EndTime": "2025-11-12T02:13:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5ebcb0b-74ab-4995-8131-0106f0a8045a",
"928a7acd-ae5a-48d9-b665-c04f65010402"
],
"Companies": [
"f255dd80-396f-44d4-b003-f06139c84a4f",
"cbcf50d4-486f-4ad4-a55e-5429f8ef5ab7"
],
"Groups": [
"81c61d17-90fe-4455-88af-3bb7245cb4fe",
"6016ce72-e9fe-426e-99e3-d236a3f3d727"
],
"Opportunities": [
"838f207b-a20f-4001-a4b6-34dbc8c2b08e",
"d5e60cdc-38e6-4b42-b248-64e377a3af49"
]
}
},
{
"Id": "268a93f1-f4ea-4a45-b791-90ab371fd4cd",
"SeriesId": "0cf2d52f-25b7-4e9d-9f11-5b0bbced105f",
"AccessorID": "64d734eb-4b59-4a4a-8842-3a7cd9f4b2f2",
"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": "69fb9cea-c72c-4af2-8000-b23fa6fbd53a",
"ScheduledByID": "6fd43b13-ce26-4f65-bb26-7c538d6118ed",
"DeletedDates": [
"2025-11-12T02:13:46Z",
"2025-11-12T02:13:46Z"
],
"ClearedDates": [
"2025-11-12T02:13:46Z",
"2025-11-12T02:13:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-12T02:13:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-12T02:13:46Z",
"CreateDate": "2025-11-12T02:13:46Z",
"OccurTime": "2025-11-12T02:13:46Z",
"OccurEndTime": "2025-11-12T02:13:46Z",
"StartTime": "2025-11-12T02:13:46Z",
"EndTime": "2025-11-12T02:13:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e5ebcb0b-74ab-4995-8131-0106f0a8045a",
"928a7acd-ae5a-48d9-b665-c04f65010402"
],
"Companies": [
"f255dd80-396f-44d4-b003-f06139c84a4f",
"cbcf50d4-486f-4ad4-a55e-5429f8ef5ab7"
],
"Groups": [
"81c61d17-90fe-4455-88af-3bb7245cb4fe",
"6016ce72-e9fe-426e-99e3-d236a3f3d727"
],
"Opportunities": [
"838f207b-a20f-4001-a4b6-34dbc8c2b08e",
"d5e60cdc-38e6-4b42-b248-64e377a3af49"
]
}
}
]