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": "c083c06b-5e9b-4018-9408-2792360667bc",
"SeriesId": "ebc0ff2d-e21a-4134-ba9b-bfe1662439e4",
"AccessorID": "e77ff51a-ce1a-4cda-b733-2b0085f6204a",
"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": "1f27bd50-93e2-414f-8144-4db4e0aa1f1c",
"ScheduledByID": "decb1262-030e-400c-adbf-92e9623bec87",
"DeletedDates": [
"2026-03-29T15:27:37Z",
"2026-03-29T15:27:37Z"
],
"ClearedDates": [
"2026-03-29T15:27:37Z",
"2026-03-29T15:27:37Z"
],
"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-29T15:27:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-29T15:27:37Z",
"CreateDate": "2026-03-29T15:27:37Z",
"OccurTime": "2026-03-29T15:27:37Z",
"OccurEndTime": "2026-03-29T15:27:37Z",
"StartTime": "2026-03-29T15:27:37Z",
"EndTime": "2026-03-29T15:27:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4541ad3e-1da3-4ea6-a07f-237db668115b",
"49b2067f-0894-497e-96ae-bfa8eca3886a"
],
"Companies": [
"c2b143b7-77d8-4b47-8616-44cf3a4ef078",
"4095f88e-8f34-4019-a05d-118f0bf7cd12"
],
"Groups": [
"096abce7-d9a8-4a12-9496-de6ff46c7a43",
"2de90392-a88d-4541-b749-4f725efcab8c"
],
"Opportunities": [
"5841ba5c-c875-44d0-b896-1a680f72418d",
"e9c29aab-5f8e-4731-8e6b-d25431544a2c"
]
}
},
{
"Id": "c083c06b-5e9b-4018-9408-2792360667bc",
"SeriesId": "ebc0ff2d-e21a-4134-ba9b-bfe1662439e4",
"AccessorID": "e77ff51a-ce1a-4cda-b733-2b0085f6204a",
"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": "1f27bd50-93e2-414f-8144-4db4e0aa1f1c",
"ScheduledByID": "decb1262-030e-400c-adbf-92e9623bec87",
"DeletedDates": [
"2026-03-29T15:27:37Z",
"2026-03-29T15:27:37Z"
],
"ClearedDates": [
"2026-03-29T15:27:37Z",
"2026-03-29T15:27:37Z"
],
"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-29T15:27:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-29T15:27:37Z",
"CreateDate": "2026-03-29T15:27:37Z",
"OccurTime": "2026-03-29T15:27:37Z",
"OccurEndTime": "2026-03-29T15:27:37Z",
"StartTime": "2026-03-29T15:27:37Z",
"EndTime": "2026-03-29T15:27:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4541ad3e-1da3-4ea6-a07f-237db668115b",
"49b2067f-0894-497e-96ae-bfa8eca3886a"
],
"Companies": [
"c2b143b7-77d8-4b47-8616-44cf3a4ef078",
"4095f88e-8f34-4019-a05d-118f0bf7cd12"
],
"Groups": [
"096abce7-d9a8-4a12-9496-de6ff46c7a43",
"2de90392-a88d-4541-b749-4f725efcab8c"
],
"Opportunities": [
"5841ba5c-c875-44d0-b896-1a680f72418d",
"e9c29aab-5f8e-4731-8e6b-d25431544a2c"
]
}
}
]