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": "5e54356d-9ef4-4ab5-a4d1-1fb247fc7272",
"SeriesId": "27d8281b-82bc-4656-bb7c-aed6ccbfb0fe",
"AccessorID": "6a1c9f1b-cb54-443e-be1c-ca76509857f2",
"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": "d33b0359-3362-4ae0-924f-80b36ac733ad",
"ScheduledByID": "05ea7637-639f-4b0f-b83a-db4e540c2204",
"DeletedDates": [
"2026-03-15T20:03:16Z",
"2026-03-15T20:03:16Z"
],
"ClearedDates": [
"2026-03-15T20:03:16Z",
"2026-03-15T20:03:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-15T20:03:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-15T20:03:16Z",
"CreateDate": "2026-03-15T20:03:16Z",
"OccurTime": "2026-03-15T20:03:16Z",
"OccurEndTime": "2026-03-15T20:03:16Z",
"StartTime": "2026-03-15T20:03:16Z",
"EndTime": "2026-03-15T20:03:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"97295da7-e0ec-4e68-b441-def9a22d4994",
"a9f45cd8-dda4-4eeb-8b36-81a44d4bf8e2"
],
"Companies": [
"1ce32bed-90be-4ad9-b8ee-10a01c264e20",
"a49dbc3d-f965-4c91-b272-f347cc181038"
],
"Groups": [
"9667709f-34f8-4077-ab50-71869eace6f6",
"4f614750-d9f2-484a-8898-5508afa3a923"
],
"Opportunities": [
"aa6ed1bf-64c3-45f5-8822-b36ca0ed05cb",
"bfbcd5d4-dab5-4610-b577-67bf0c6fb658"
]
}
},
{
"Id": "5e54356d-9ef4-4ab5-a4d1-1fb247fc7272",
"SeriesId": "27d8281b-82bc-4656-bb7c-aed6ccbfb0fe",
"AccessorID": "6a1c9f1b-cb54-443e-be1c-ca76509857f2",
"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": "d33b0359-3362-4ae0-924f-80b36ac733ad",
"ScheduledByID": "05ea7637-639f-4b0f-b83a-db4e540c2204",
"DeletedDates": [
"2026-03-15T20:03:16Z",
"2026-03-15T20:03:16Z"
],
"ClearedDates": [
"2026-03-15T20:03:16Z",
"2026-03-15T20:03:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-03-15T20:03:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-15T20:03:16Z",
"CreateDate": "2026-03-15T20:03:16Z",
"OccurTime": "2026-03-15T20:03:16Z",
"OccurEndTime": "2026-03-15T20:03:16Z",
"StartTime": "2026-03-15T20:03:16Z",
"EndTime": "2026-03-15T20:03:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"97295da7-e0ec-4e68-b441-def9a22d4994",
"a9f45cd8-dda4-4eeb-8b36-81a44d4bf8e2"
],
"Companies": [
"1ce32bed-90be-4ad9-b8ee-10a01c264e20",
"a49dbc3d-f965-4c91-b272-f347cc181038"
],
"Groups": [
"9667709f-34f8-4077-ab50-71869eace6f6",
"4f614750-d9f2-484a-8898-5508afa3a923"
],
"Opportunities": [
"aa6ed1bf-64c3-45f5-8822-b36ca0ed05cb",
"bfbcd5d4-dab5-4610-b577-67bf0c6fb658"
]
}
}
]