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": "ef21bf3d-ea1f-4655-b3ea-372d74e45360",
"SeriesId": "3b065ec6-571b-4897-bad4-cab22a533449",
"AccessorID": "6a71c388-d80d-4c2b-939e-4a6b0413a077",
"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": "6ab63e9f-75e4-4bce-8e53-6a0fa05c65d2",
"ScheduledByID": "7e3af10f-b52e-44b5-bb0a-79c49db238f7",
"DeletedDates": [
"2025-12-09T15:36:08Z",
"2025-12-09T15:36:08Z"
],
"ClearedDates": [
"2025-12-09T15:36:08Z",
"2025-12-09T15:36:08Z"
],
"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-09T15:36:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-09T15:36:08Z",
"CreateDate": "2025-12-09T15:36:08Z",
"OccurTime": "2025-12-09T15:36:08Z",
"OccurEndTime": "2025-12-09T15:36:08Z",
"StartTime": "2025-12-09T15:36:08Z",
"EndTime": "2025-12-09T15:36:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4093c4d4-a075-4fe0-a09a-3506b9c30737",
"07ce0f9d-6e92-47b4-ba8e-c71f38ba48de"
],
"Companies": [
"075bc816-0ead-4958-b804-60db58cc568e",
"8f921825-09cb-436a-91ea-73ca77034550"
],
"Groups": [
"afa568be-4076-48a6-ae57-3918142ecbf6",
"c119beb2-6fe6-44e9-b9fe-d2b57c9e051a"
],
"Opportunities": [
"0e7c9540-26a1-43c4-b4f0-7654af222fed",
"f819942e-ec87-4c7c-89d2-ab053dbc05e3"
]
}
},
{
"Id": "ef21bf3d-ea1f-4655-b3ea-372d74e45360",
"SeriesId": "3b065ec6-571b-4897-bad4-cab22a533449",
"AccessorID": "6a71c388-d80d-4c2b-939e-4a6b0413a077",
"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": "6ab63e9f-75e4-4bce-8e53-6a0fa05c65d2",
"ScheduledByID": "7e3af10f-b52e-44b5-bb0a-79c49db238f7",
"DeletedDates": [
"2025-12-09T15:36:08Z",
"2025-12-09T15:36:08Z"
],
"ClearedDates": [
"2025-12-09T15:36:08Z",
"2025-12-09T15:36:08Z"
],
"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-09T15:36:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-09T15:36:08Z",
"CreateDate": "2025-12-09T15:36:08Z",
"OccurTime": "2025-12-09T15:36:08Z",
"OccurEndTime": "2025-12-09T15:36:08Z",
"StartTime": "2025-12-09T15:36:08Z",
"EndTime": "2025-12-09T15:36:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4093c4d4-a075-4fe0-a09a-3506b9c30737",
"07ce0f9d-6e92-47b4-ba8e-c71f38ba48de"
],
"Companies": [
"075bc816-0ead-4958-b804-60db58cc568e",
"8f921825-09cb-436a-91ea-73ca77034550"
],
"Groups": [
"afa568be-4076-48a6-ae57-3918142ecbf6",
"c119beb2-6fe6-44e9-b9fe-d2b57c9e051a"
],
"Opportunities": [
"0e7c9540-26a1-43c4-b4f0-7654af222fed",
"f819942e-ec87-4c7c-89d2-ab053dbc05e3"
]
}
}
]