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": "15452977-be6a-4b89-8ba9-73496411c6f5",
"SeriesId": "0d44e1a5-8f84-4f37-bd07-e74176a06b11",
"AccessorID": "51faa3f0-0cb2-4cb9-ae94-1f04ef3ee0ef",
"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": "3ea8faea-d457-4535-9cf0-b3d2d64156ba",
"ScheduledByID": "08a86f4f-bbec-4761-89f8-5e2505d2e1dc",
"DeletedDates": [
"2025-12-11T17:01:37Z",
"2025-12-11T17:01:37Z"
],
"ClearedDates": [
"2025-12-11T17:01:37Z",
"2025-12-11T17:01: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-11T17:01:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-11T17:01:37Z",
"CreateDate": "2025-12-11T17:01:37Z",
"OccurTime": "2025-12-11T17:01:37Z",
"OccurEndTime": "2025-12-11T17:01:37Z",
"StartTime": "2025-12-11T17:01:37Z",
"EndTime": "2025-12-11T17:01:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ce27f3ad-45c7-49fd-901e-fb1198060ded",
"bf7fa136-0200-4e5d-864c-47b5f077ce9d"
],
"Companies": [
"2d6b5f41-b8ab-41db-8812-a9ebf4f30a6b",
"91b08030-015a-4cb4-992c-960d14e3f85f"
],
"Groups": [
"76b2b880-d339-422b-bd2d-9905b1571f95",
"7a788222-a00d-4eb1-91b1-7c766926e6c7"
],
"Opportunities": [
"a7f4ac67-1dd4-41c7-8610-16ad7e7cfd43",
"cddb0a68-55dc-4f1f-a120-e36d7dfc5333"
]
}
},
{
"Id": "15452977-be6a-4b89-8ba9-73496411c6f5",
"SeriesId": "0d44e1a5-8f84-4f37-bd07-e74176a06b11",
"AccessorID": "51faa3f0-0cb2-4cb9-ae94-1f04ef3ee0ef",
"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": "3ea8faea-d457-4535-9cf0-b3d2d64156ba",
"ScheduledByID": "08a86f4f-bbec-4761-89f8-5e2505d2e1dc",
"DeletedDates": [
"2025-12-11T17:01:37Z",
"2025-12-11T17:01:37Z"
],
"ClearedDates": [
"2025-12-11T17:01:37Z",
"2025-12-11T17:01: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-11T17:01:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-11T17:01:37Z",
"CreateDate": "2025-12-11T17:01:37Z",
"OccurTime": "2025-12-11T17:01:37Z",
"OccurEndTime": "2025-12-11T17:01:37Z",
"StartTime": "2025-12-11T17:01:37Z",
"EndTime": "2025-12-11T17:01:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ce27f3ad-45c7-49fd-901e-fb1198060ded",
"bf7fa136-0200-4e5d-864c-47b5f077ce9d"
],
"Companies": [
"2d6b5f41-b8ab-41db-8812-a9ebf4f30a6b",
"91b08030-015a-4cb4-992c-960d14e3f85f"
],
"Groups": [
"76b2b880-d339-422b-bd2d-9905b1571f95",
"7a788222-a00d-4eb1-91b1-7c766926e6c7"
],
"Opportunities": [
"a7f4ac67-1dd4-41c7-8610-16ad7e7cfd43",
"cddb0a68-55dc-4f1f-a120-e36d7dfc5333"
]
}
}
]