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": "bf7b90fd-4584-4f8a-b9b0-766f3dad984a",
"SeriesId": "bb7902e6-5adf-4f3b-91e0-d97444999c55",
"AccessorID": "13603e6d-33ec-430e-a34c-5fce92d645c0",
"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": "83812263-ccb4-4ce0-ae25-6d628ae0e238",
"ScheduledByID": "c796b016-49c0-4a7f-ae67-4162f66fd5c7",
"DeletedDates": [
"2026-04-22T01:30:32Z",
"2026-04-22T01:30:32Z"
],
"ClearedDates": [
"2026-04-22T01:30:32Z",
"2026-04-22T01:30:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-22T01:30:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-22T01:30:32Z",
"CreateDate": "2026-04-22T01:30:32Z",
"OccurTime": "2026-04-22T01:30:32Z",
"OccurEndTime": "2026-04-22T01:30:32Z",
"StartTime": "2026-04-22T01:30:32Z",
"EndTime": "2026-04-22T01:30:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e1146b11-02d9-4627-bd57-f3caeb9fe8c2",
"91c7a649-d164-48e1-82d1-20e397321a3f"
],
"Companies": [
"9a0be2a0-71de-495b-b606-44aa4eddfca1",
"1b306c85-002e-4dfe-9671-d24168d5a9c6"
],
"Groups": [
"d8a2cb4a-432d-42be-894c-0371bfd835af",
"ae86db13-daba-40e5-b3fe-697b326dcd8b"
],
"Opportunities": [
"ac9c70d4-63ff-40e8-b187-7a0ea95315bd",
"fca778d0-0f1d-4e67-8348-cafbf42537d6"
]
}
},
{
"Id": "bf7b90fd-4584-4f8a-b9b0-766f3dad984a",
"SeriesId": "bb7902e6-5adf-4f3b-91e0-d97444999c55",
"AccessorID": "13603e6d-33ec-430e-a34c-5fce92d645c0",
"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": "83812263-ccb4-4ce0-ae25-6d628ae0e238",
"ScheduledByID": "c796b016-49c0-4a7f-ae67-4162f66fd5c7",
"DeletedDates": [
"2026-04-22T01:30:32Z",
"2026-04-22T01:30:32Z"
],
"ClearedDates": [
"2026-04-22T01:30:32Z",
"2026-04-22T01:30:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-22T01:30:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-22T01:30:32Z",
"CreateDate": "2026-04-22T01:30:32Z",
"OccurTime": "2026-04-22T01:30:32Z",
"OccurEndTime": "2026-04-22T01:30:32Z",
"StartTime": "2026-04-22T01:30:32Z",
"EndTime": "2026-04-22T01:30:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e1146b11-02d9-4627-bd57-f3caeb9fe8c2",
"91c7a649-d164-48e1-82d1-20e397321a3f"
],
"Companies": [
"9a0be2a0-71de-495b-b606-44aa4eddfca1",
"1b306c85-002e-4dfe-9671-d24168d5a9c6"
],
"Groups": [
"d8a2cb4a-432d-42be-894c-0371bfd835af",
"ae86db13-daba-40e5-b3fe-697b326dcd8b"
],
"Opportunities": [
"ac9c70d4-63ff-40e8-b187-7a0ea95315bd",
"fca778d0-0f1d-4e67-8348-cafbf42537d6"
]
}
}
]