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": "8335c220-ebe9-4cbc-bcae-bb03991cbdc3",
"SeriesId": "a9be7539-5128-42d6-b4f0-23ba53b062d3",
"AccessorID": "11bf6a56-d17a-4452-88e5-e28cfb187467",
"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": "11eb85f5-e3ca-4b36-bb67-27b49b0916dc",
"ScheduledByID": "2642d1a4-5e56-446e-ac14-561d68ac1738",
"DeletedDates": [
"2026-02-10T21:46:51Z",
"2026-02-10T21:46:51Z"
],
"ClearedDates": [
"2026-02-10T21:46:51Z",
"2026-02-10T21:46:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-10T21:46:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-10T21:46:51Z",
"CreateDate": "2026-02-10T21:46:51Z",
"OccurTime": "2026-02-10T21:46:51Z",
"OccurEndTime": "2026-02-10T21:46:51Z",
"StartTime": "2026-02-10T21:46:51Z",
"EndTime": "2026-02-10T21:46:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0eec914a-0724-4d10-b503-89a07343f41c",
"4b332d25-c4f4-4188-85c9-ae8d09373033"
],
"Companies": [
"d1707089-c934-415f-8cac-2aca58bbbca0",
"138ccf5e-8346-4460-b94e-0347beec3b3b"
],
"Groups": [
"a03067a4-5a09-40cc-937d-ec4f17849be5",
"67f7f772-4b37-4075-bbfd-55ccb8bf858c"
],
"Opportunities": [
"98addfcd-ae82-4ec8-b2c8-07a2d649e0b6",
"dce7cccc-1928-4db3-b219-4d0a768f447d"
]
}
},
{
"Id": "8335c220-ebe9-4cbc-bcae-bb03991cbdc3",
"SeriesId": "a9be7539-5128-42d6-b4f0-23ba53b062d3",
"AccessorID": "11bf6a56-d17a-4452-88e5-e28cfb187467",
"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": "11eb85f5-e3ca-4b36-bb67-27b49b0916dc",
"ScheduledByID": "2642d1a4-5e56-446e-ac14-561d68ac1738",
"DeletedDates": [
"2026-02-10T21:46:51Z",
"2026-02-10T21:46:51Z"
],
"ClearedDates": [
"2026-02-10T21:46:51Z",
"2026-02-10T21:46:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-10T21:46:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-10T21:46:51Z",
"CreateDate": "2026-02-10T21:46:51Z",
"OccurTime": "2026-02-10T21:46:51Z",
"OccurEndTime": "2026-02-10T21:46:51Z",
"StartTime": "2026-02-10T21:46:51Z",
"EndTime": "2026-02-10T21:46:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0eec914a-0724-4d10-b503-89a07343f41c",
"4b332d25-c4f4-4188-85c9-ae8d09373033"
],
"Companies": [
"d1707089-c934-415f-8cac-2aca58bbbca0",
"138ccf5e-8346-4460-b94e-0347beec3b3b"
],
"Groups": [
"a03067a4-5a09-40cc-937d-ec4f17849be5",
"67f7f772-4b37-4075-bbfd-55ccb8bf858c"
],
"Opportunities": [
"98addfcd-ae82-4ec8-b2c8-07a2d649e0b6",
"dce7cccc-1928-4db3-b219-4d0a768f447d"
]
}
}
]