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": "328a0025-992a-4180-9685-0007142ee756",
"SeriesId": "92fc2e2d-9e0b-4797-9ff7-977d6eb92d19",
"AccessorID": "af4e3171-5827-4fd0-b543-bd6a21aa6690",
"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": "d17f965e-9fbe-45bb-ab02-c92e79271394",
"ScheduledByID": "33fc2bc3-948a-4d97-985d-993ae0fa8b2f",
"DeletedDates": [
"2026-02-02T16:12:51Z",
"2026-02-02T16:12:51Z"
],
"ClearedDates": [
"2026-02-02T16:12:51Z",
"2026-02-02T16:12:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-02T16:12:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-02T16:12:51Z",
"CreateDate": "2026-02-02T16:12:51Z",
"OccurTime": "2026-02-02T16:12:51Z",
"OccurEndTime": "2026-02-02T16:12:51Z",
"StartTime": "2026-02-02T16:12:51Z",
"EndTime": "2026-02-02T16:12:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa6f9a6c-48bf-4319-9218-e80d904b20b4",
"a7a06153-5dcf-4d70-af76-42cf8da95bcf"
],
"Companies": [
"4cda723b-d4a4-470f-94fc-74153378ce81",
"e6e19983-0ac9-4212-a080-57a574bbf06f"
],
"Groups": [
"4fc17309-3f5c-47ef-b886-c29bdc94ce28",
"23d979ac-38ce-4b65-a8d7-96936078f47b"
],
"Opportunities": [
"f8fe90c1-ffdb-44cc-9f86-5d7009a0b6b3",
"fbebc451-3b86-45a7-b534-c2ebee487347"
]
}
},
{
"Id": "328a0025-992a-4180-9685-0007142ee756",
"SeriesId": "92fc2e2d-9e0b-4797-9ff7-977d6eb92d19",
"AccessorID": "af4e3171-5827-4fd0-b543-bd6a21aa6690",
"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": "d17f965e-9fbe-45bb-ab02-c92e79271394",
"ScheduledByID": "33fc2bc3-948a-4d97-985d-993ae0fa8b2f",
"DeletedDates": [
"2026-02-02T16:12:51Z",
"2026-02-02T16:12:51Z"
],
"ClearedDates": [
"2026-02-02T16:12:51Z",
"2026-02-02T16:12:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-02T16:12:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-02T16:12:51Z",
"CreateDate": "2026-02-02T16:12:51Z",
"OccurTime": "2026-02-02T16:12:51Z",
"OccurEndTime": "2026-02-02T16:12:51Z",
"StartTime": "2026-02-02T16:12:51Z",
"EndTime": "2026-02-02T16:12:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa6f9a6c-48bf-4319-9218-e80d904b20b4",
"a7a06153-5dcf-4d70-af76-42cf8da95bcf"
],
"Companies": [
"4cda723b-d4a4-470f-94fc-74153378ce81",
"e6e19983-0ac9-4212-a080-57a574bbf06f"
],
"Groups": [
"4fc17309-3f5c-47ef-b886-c29bdc94ce28",
"23d979ac-38ce-4b65-a8d7-96936078f47b"
],
"Opportunities": [
"f8fe90c1-ffdb-44cc-9f86-5d7009a0b6b3",
"fbebc451-3b86-45a7-b534-c2ebee487347"
]
}
}
]