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": "53dc6cf1-7ae5-452b-8a7d-eb658902aa4e",
"SeriesId": "e7bb536d-df72-400a-881e-95d3038404bc",
"AccessorID": "382caee5-a4ca-4047-af81-7e8bbe9e1ad4",
"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": "f97d539b-dcc1-469d-9903-ee641d8ebc2f",
"ScheduledByID": "3bf333fc-7b3e-4245-a11e-fd5ec772a228",
"DeletedDates": [
"2025-12-25T12:59:37Z",
"2025-12-25T12:59:37Z"
],
"ClearedDates": [
"2025-12-25T12:59:37Z",
"2025-12-25T12:59:37Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-25T12:59:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-25T12:59:37Z",
"CreateDate": "2025-12-25T12:59:37Z",
"OccurTime": "2025-12-25T12:59:37Z",
"OccurEndTime": "2025-12-25T12:59:37Z",
"StartTime": "2025-12-25T12:59:37Z",
"EndTime": "2025-12-25T12:59:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"20af8294-54e4-49da-9369-0303c9e7e783",
"114e6b30-cf52-4a44-8fd1-5df413dba34b"
],
"Companies": [
"870a4404-52b8-45d5-9dcf-ea17223c6d2b",
"b0237a75-facd-4240-9f75-410e164f26f5"
],
"Groups": [
"56be1c27-ae5f-42d0-9952-0d885d761456",
"83e14fb3-c9d1-4127-8cf0-52189b5f4698"
],
"Opportunities": [
"1da99ee9-6df6-4a3b-9488-5b99c09c8b89",
"85d7bde8-b4e0-431d-8288-84eabe89d392"
]
}
},
{
"Id": "53dc6cf1-7ae5-452b-8a7d-eb658902aa4e",
"SeriesId": "e7bb536d-df72-400a-881e-95d3038404bc",
"AccessorID": "382caee5-a4ca-4047-af81-7e8bbe9e1ad4",
"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": "f97d539b-dcc1-469d-9903-ee641d8ebc2f",
"ScheduledByID": "3bf333fc-7b3e-4245-a11e-fd5ec772a228",
"DeletedDates": [
"2025-12-25T12:59:37Z",
"2025-12-25T12:59:37Z"
],
"ClearedDates": [
"2025-12-25T12:59:37Z",
"2025-12-25T12:59:37Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-25T12:59:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-25T12:59:37Z",
"CreateDate": "2025-12-25T12:59:37Z",
"OccurTime": "2025-12-25T12:59:37Z",
"OccurEndTime": "2025-12-25T12:59:37Z",
"StartTime": "2025-12-25T12:59:37Z",
"EndTime": "2025-12-25T12:59:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"20af8294-54e4-49da-9369-0303c9e7e783",
"114e6b30-cf52-4a44-8fd1-5df413dba34b"
],
"Companies": [
"870a4404-52b8-45d5-9dcf-ea17223c6d2b",
"b0237a75-facd-4240-9f75-410e164f26f5"
],
"Groups": [
"56be1c27-ae5f-42d0-9952-0d885d761456",
"83e14fb3-c9d1-4127-8cf0-52189b5f4698"
],
"Opportunities": [
"1da99ee9-6df6-4a3b-9488-5b99c09c8b89",
"85d7bde8-b4e0-431d-8288-84eabe89d392"
]
}
}
]