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": "4f008dea-112a-402b-a2f9-529559160ea0",
"SeriesId": "d43d60de-ef86-4c0c-9e2f-65cf62f482c6",
"AccessorID": "ffb7c321-05d4-4992-92be-9f419b37c1e9",
"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": "fdc63124-1aed-4ac4-a144-9dca3f4ea6b7",
"ScheduledByID": "cea18d3d-6ade-4ec5-a239-fd393550f6a2",
"DeletedDates": [
"2025-12-02T03:07:14Z",
"2025-12-02T03:07:14Z"
],
"ClearedDates": [
"2025-12-02T03:07:14Z",
"2025-12-02T03:07:14Z"
],
"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-02T03:07:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-02T03:07:14Z",
"CreateDate": "2025-12-02T03:07:14Z",
"OccurTime": "2025-12-02T03:07:14Z",
"OccurEndTime": "2025-12-02T03:07:14Z",
"StartTime": "2025-12-02T03:07:14Z",
"EndTime": "2025-12-02T03:07:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"58e1b888-74e2-455b-9444-e4e80ef92fe2",
"06c3ad5b-1f61-4744-bb48-6a9ccd7bdfae"
],
"Companies": [
"36207c78-0251-4dca-aeec-87a182b13ca0",
"82efd034-99c8-4190-99a4-e39747a22c8e"
],
"Groups": [
"4d49e6dc-71b7-49d9-b14d-38b92bf3067b",
"a0ebb60c-7025-47fa-adc5-fa33ffa34f0a"
],
"Opportunities": [
"f31334f6-191d-41e1-849d-6c003808dfa3",
"d23c2633-af79-4cc7-8ea3-f846ec13ba16"
]
}
},
{
"Id": "4f008dea-112a-402b-a2f9-529559160ea0",
"SeriesId": "d43d60de-ef86-4c0c-9e2f-65cf62f482c6",
"AccessorID": "ffb7c321-05d4-4992-92be-9f419b37c1e9",
"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": "fdc63124-1aed-4ac4-a144-9dca3f4ea6b7",
"ScheduledByID": "cea18d3d-6ade-4ec5-a239-fd393550f6a2",
"DeletedDates": [
"2025-12-02T03:07:14Z",
"2025-12-02T03:07:14Z"
],
"ClearedDates": [
"2025-12-02T03:07:14Z",
"2025-12-02T03:07:14Z"
],
"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-02T03:07:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-02T03:07:14Z",
"CreateDate": "2025-12-02T03:07:14Z",
"OccurTime": "2025-12-02T03:07:14Z",
"OccurEndTime": "2025-12-02T03:07:14Z",
"StartTime": "2025-12-02T03:07:14Z",
"EndTime": "2025-12-02T03:07:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"58e1b888-74e2-455b-9444-e4e80ef92fe2",
"06c3ad5b-1f61-4744-bb48-6a9ccd7bdfae"
],
"Companies": [
"36207c78-0251-4dca-aeec-87a182b13ca0",
"82efd034-99c8-4190-99a4-e39747a22c8e"
],
"Groups": [
"4d49e6dc-71b7-49d9-b14d-38b92bf3067b",
"a0ebb60c-7025-47fa-adc5-fa33ffa34f0a"
],
"Opportunities": [
"f31334f6-191d-41e1-849d-6c003808dfa3",
"d23c2633-af79-4cc7-8ea3-f846ec13ba16"
]
}
}
]