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": "7b5b8de2-d4b5-44c3-b229-2453f7ffec0d",
"SeriesId": "bef37ea8-d531-4de8-a72b-4ddb0f805202",
"AccessorID": "a938dd80-e54e-4bb1-9c81-74d5427f6e06",
"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": "c2873d7a-f43a-408a-9e4b-b0e249dd66ed",
"ScheduledByID": "c59dbd73-02ab-422b-ae2f-deb623ddd392",
"DeletedDates": [
"2026-03-09T18:05:41Z",
"2026-03-09T18:05:41Z"
],
"ClearedDates": [
"2026-03-09T18:05:41Z",
"2026-03-09T18:05:41Z"
],
"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-09T18:05:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-09T18:05:42Z",
"CreateDate": "2026-03-09T18:05:42Z",
"OccurTime": "2026-03-09T18:05:42Z",
"OccurEndTime": "2026-03-09T18:05:42Z",
"StartTime": "2026-03-09T18:05:42Z",
"EndTime": "2026-03-09T18:05:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d9c8e6a3-eb54-48f2-ba49-5a14a1d29da0",
"3f53f585-0f8e-4635-89fc-05758cc46818"
],
"Companies": [
"a87854ea-41de-47fa-9f13-11de142fce63",
"f7355b61-3e59-432b-8774-28111c812253"
],
"Groups": [
"be736c8e-3e7f-4d87-91de-85fac4dbdd05",
"25c45e0a-0a6b-410f-a7b2-a99aaaf23679"
],
"Opportunities": [
"95d7a205-edf0-4fe6-a7a6-7c141e345e70",
"b94ade6e-1866-4805-99a1-8625a74a43bf"
]
}
},
{
"Id": "7b5b8de2-d4b5-44c3-b229-2453f7ffec0d",
"SeriesId": "bef37ea8-d531-4de8-a72b-4ddb0f805202",
"AccessorID": "a938dd80-e54e-4bb1-9c81-74d5427f6e06",
"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": "c2873d7a-f43a-408a-9e4b-b0e249dd66ed",
"ScheduledByID": "c59dbd73-02ab-422b-ae2f-deb623ddd392",
"DeletedDates": [
"2026-03-09T18:05:41Z",
"2026-03-09T18:05:41Z"
],
"ClearedDates": [
"2026-03-09T18:05:41Z",
"2026-03-09T18:05:41Z"
],
"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-09T18:05:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-03-09T18:05:42Z",
"CreateDate": "2026-03-09T18:05:42Z",
"OccurTime": "2026-03-09T18:05:42Z",
"OccurEndTime": "2026-03-09T18:05:42Z",
"StartTime": "2026-03-09T18:05:42Z",
"EndTime": "2026-03-09T18:05:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d9c8e6a3-eb54-48f2-ba49-5a14a1d29da0",
"3f53f585-0f8e-4635-89fc-05758cc46818"
],
"Companies": [
"a87854ea-41de-47fa-9f13-11de142fce63",
"f7355b61-3e59-432b-8774-28111c812253"
],
"Groups": [
"be736c8e-3e7f-4d87-91de-85fac4dbdd05",
"25c45e0a-0a6b-410f-a7b2-a99aaaf23679"
],
"Opportunities": [
"95d7a205-edf0-4fe6-a7a6-7c141e345e70",
"b94ade6e-1866-4805-99a1-8625a74a43bf"
]
}
}
]