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": "dbe55ba2-325a-42a9-b5ce-8841037ad1f2",
"SeriesId": "eada12b8-4248-4b5e-bb23-02fcf3d1ee19",
"AccessorID": "a91546ed-d44d-4aed-bf41-928f7bf27719",
"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": "48f46c48-adf4-4c52-a4f7-70a6126a2bc8",
"ScheduledByID": "b8edc498-9200-4ff2-b043-96eb685aadef",
"DeletedDates": [
"2025-11-04T23:31:28Z",
"2025-11-04T23:31:28Z"
],
"ClearedDates": [
"2025-11-04T23:31:28Z",
"2025-11-04T23:31:28Z"
],
"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-04T23:31:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-04T23:31:28Z",
"CreateDate": "2025-11-04T23:31:28Z",
"OccurTime": "2025-11-04T23:31:28Z",
"OccurEndTime": "2025-11-04T23:31:28Z",
"StartTime": "2025-11-04T23:31:28Z",
"EndTime": "2025-11-04T23:31:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d8c5caa1-92ac-4ad2-aa35-ed3dd3b32f06",
"050c6d19-7301-4628-9a37-7709c5d9abee"
],
"Companies": [
"03c1fb40-369b-418c-a4f3-a783b1b0a1ba",
"1051b26f-3e6d-4c25-9bde-0c4138f8d323"
],
"Groups": [
"ab013e42-e5be-412e-8bb6-cfa4139c03c0",
"52cb78bd-d32f-41d2-8d46-56c5c40ec630"
],
"Opportunities": [
"797af888-0c46-4cc4-9874-c0cc68d10533",
"eecb0dd0-4e6b-4e25-8fbc-acb8ba76b186"
]
}
},
{
"Id": "dbe55ba2-325a-42a9-b5ce-8841037ad1f2",
"SeriesId": "eada12b8-4248-4b5e-bb23-02fcf3d1ee19",
"AccessorID": "a91546ed-d44d-4aed-bf41-928f7bf27719",
"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": "48f46c48-adf4-4c52-a4f7-70a6126a2bc8",
"ScheduledByID": "b8edc498-9200-4ff2-b043-96eb685aadef",
"DeletedDates": [
"2025-11-04T23:31:28Z",
"2025-11-04T23:31:28Z"
],
"ClearedDates": [
"2025-11-04T23:31:28Z",
"2025-11-04T23:31:28Z"
],
"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-04T23:31:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-04T23:31:28Z",
"CreateDate": "2025-11-04T23:31:28Z",
"OccurTime": "2025-11-04T23:31:28Z",
"OccurEndTime": "2025-11-04T23:31:28Z",
"StartTime": "2025-11-04T23:31:28Z",
"EndTime": "2025-11-04T23:31:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d8c5caa1-92ac-4ad2-aa35-ed3dd3b32f06",
"050c6d19-7301-4628-9a37-7709c5d9abee"
],
"Companies": [
"03c1fb40-369b-418c-a4f3-a783b1b0a1ba",
"1051b26f-3e6d-4c25-9bde-0c4138f8d323"
],
"Groups": [
"ab013e42-e5be-412e-8bb6-cfa4139c03c0",
"52cb78bd-d32f-41d2-8d46-56c5c40ec630"
],
"Opportunities": [
"797af888-0c46-4cc4-9874-c0cc68d10533",
"eecb0dd0-4e6b-4e25-8fbc-acb8ba76b186"
]
}
}
]