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": "a54df31b-e0fa-409d-86cc-e1b3a843a5ac",
"SeriesId": "4001cadc-4611-4084-a7a2-214ae0939760",
"AccessorID": "e4c689ec-4bc7-4ac1-9cfd-896492538414",
"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": "87ff9ce1-03b9-4706-ba18-6af50d09b9bd",
"ScheduledByID": "4c0d17c3-a226-4dbc-9b7e-9078742f1977",
"DeletedDates": [
"2026-01-19T17:01:53Z",
"2026-01-19T17:01:53Z"
],
"ClearedDates": [
"2026-01-19T17:01:53Z",
"2026-01-19T17:01:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-19T17:01:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-19T17:01:53Z",
"CreateDate": "2026-01-19T17:01:53Z",
"OccurTime": "2026-01-19T17:01:53Z",
"OccurEndTime": "2026-01-19T17:01:53Z",
"StartTime": "2026-01-19T17:01:53Z",
"EndTime": "2026-01-19T17:01:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f1aa859-5cff-4f5e-a6b6-360beb20b827",
"69593c94-651d-4050-ab28-4c1ae1a0f21a"
],
"Companies": [
"99a30cce-b29a-4490-8582-3fc6d155b6eb",
"2bde5701-1ba4-4ad2-9db5-369d17c54e69"
],
"Groups": [
"1719668d-4d79-4e6c-bf5a-53eaca3fab6c",
"1be6e3fa-b66e-469d-9d5b-8ad3fbbd93ad"
],
"Opportunities": [
"e1348448-4532-4483-99e3-48183b4d4d73",
"ad60079b-e804-40d1-b525-81d4c527a4bd"
]
}
},
{
"Id": "a54df31b-e0fa-409d-86cc-e1b3a843a5ac",
"SeriesId": "4001cadc-4611-4084-a7a2-214ae0939760",
"AccessorID": "e4c689ec-4bc7-4ac1-9cfd-896492538414",
"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": "87ff9ce1-03b9-4706-ba18-6af50d09b9bd",
"ScheduledByID": "4c0d17c3-a226-4dbc-9b7e-9078742f1977",
"DeletedDates": [
"2026-01-19T17:01:53Z",
"2026-01-19T17:01:53Z"
],
"ClearedDates": [
"2026-01-19T17:01:53Z",
"2026-01-19T17:01:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-19T17:01:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-19T17:01:53Z",
"CreateDate": "2026-01-19T17:01:53Z",
"OccurTime": "2026-01-19T17:01:53Z",
"OccurEndTime": "2026-01-19T17:01:53Z",
"StartTime": "2026-01-19T17:01:53Z",
"EndTime": "2026-01-19T17:01:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f1aa859-5cff-4f5e-a6b6-360beb20b827",
"69593c94-651d-4050-ab28-4c1ae1a0f21a"
],
"Companies": [
"99a30cce-b29a-4490-8582-3fc6d155b6eb",
"2bde5701-1ba4-4ad2-9db5-369d17c54e69"
],
"Groups": [
"1719668d-4d79-4e6c-bf5a-53eaca3fab6c",
"1be6e3fa-b66e-469d-9d5b-8ad3fbbd93ad"
],
"Opportunities": [
"e1348448-4532-4483-99e3-48183b4d4d73",
"ad60079b-e804-40d1-b525-81d4c527a4bd"
]
}
}
]