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": "90849344-903d-4bde-a603-64a55f9e0767",
"SeriesId": "32fc96db-0e0d-454e-9b2b-3af82f143af9",
"AccessorID": "ff744df4-efb0-4225-92f5-723fb0ccfacf",
"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": "6e20c67b-0c11-41f6-82d6-910d1c46aeea",
"ScheduledByID": "f646ce6d-ce71-4963-b6d4-8ef4290bea01",
"DeletedDates": [
"2025-11-16T16:16:46Z",
"2025-11-16T16:16:46Z"
],
"ClearedDates": [
"2025-11-16T16:16:46Z",
"2025-11-16T16:16:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-16T16:16:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-16T16:16:46Z",
"CreateDate": "2025-11-16T16:16:46Z",
"OccurTime": "2025-11-16T16:16:46Z",
"OccurEndTime": "2025-11-16T16:16:46Z",
"StartTime": "2025-11-16T16:16:46Z",
"EndTime": "2025-11-16T16:16:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a0e6c3f3-b2f7-446d-b2e2-3f8e8d70afb6",
"19b2adb7-210b-4d0d-aa53-536453eae5ab"
],
"Companies": [
"28e5d785-6905-4d69-b423-62944ba74680",
"94b40c03-f31a-4373-a51d-2290ed8c8e13"
],
"Groups": [
"b3ba06d2-e432-408e-8f1d-ff9dda854621",
"0e3cf7fe-d145-4a9b-8973-2867269900d6"
],
"Opportunities": [
"89372321-5e39-4257-b8a8-9c132ff3e808",
"90b0d22a-430e-43cf-8341-39fa23b82dcc"
]
}
},
{
"Id": "90849344-903d-4bde-a603-64a55f9e0767",
"SeriesId": "32fc96db-0e0d-454e-9b2b-3af82f143af9",
"AccessorID": "ff744df4-efb0-4225-92f5-723fb0ccfacf",
"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": "6e20c67b-0c11-41f6-82d6-910d1c46aeea",
"ScheduledByID": "f646ce6d-ce71-4963-b6d4-8ef4290bea01",
"DeletedDates": [
"2025-11-16T16:16:46Z",
"2025-11-16T16:16:46Z"
],
"ClearedDates": [
"2025-11-16T16:16:46Z",
"2025-11-16T16:16:46Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-16T16:16:46Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-16T16:16:46Z",
"CreateDate": "2025-11-16T16:16:46Z",
"OccurTime": "2025-11-16T16:16:46Z",
"OccurEndTime": "2025-11-16T16:16:46Z",
"StartTime": "2025-11-16T16:16:46Z",
"EndTime": "2025-11-16T16:16:46Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a0e6c3f3-b2f7-446d-b2e2-3f8e8d70afb6",
"19b2adb7-210b-4d0d-aa53-536453eae5ab"
],
"Companies": [
"28e5d785-6905-4d69-b423-62944ba74680",
"94b40c03-f31a-4373-a51d-2290ed8c8e13"
],
"Groups": [
"b3ba06d2-e432-408e-8f1d-ff9dda854621",
"0e3cf7fe-d145-4a9b-8973-2867269900d6"
],
"Opportunities": [
"89372321-5e39-4257-b8a8-9c132ff3e808",
"90b0d22a-430e-43cf-8341-39fa23b82dcc"
]
}
}
]