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": "7e6ead36-757c-4378-a8cb-9b7d89cf00aa",
"SeriesId": "5c2b9dcb-078b-40aa-9961-cb5e5296c5fd",
"AccessorID": "a1282b81-cdc0-4f28-b8a1-fc97159527ef",
"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": "3c6023c5-0955-4c61-9898-971bfe0e226d",
"ScheduledByID": "c4fc1731-b78c-4958-86d0-b1d64bd2a3d4",
"DeletedDates": [
"2026-05-04T00:25:16Z",
"2026-05-04T00:25:16Z"
],
"ClearedDates": [
"2026-05-04T00:25:16Z",
"2026-05-04T00:25:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-04T00:25:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T00:25:16Z",
"CreateDate": "2026-05-04T00:25:16Z",
"OccurTime": "2026-05-04T00:25:16Z",
"OccurEndTime": "2026-05-04T00:25:16Z",
"StartTime": "2026-05-04T00:25:16Z",
"EndTime": "2026-05-04T00:25:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c08e9040-7ece-4a87-8af8-162875e5f29d",
"50e1db09-f2d1-4ff2-bd0e-9d6eb0bc8134"
],
"Companies": [
"2e60d74a-8f65-4ad6-90d6-cbbc81e2c159",
"40c0df18-aa45-42f5-8603-cc320d11128e"
],
"Groups": [
"10336c60-370c-47f5-b48a-3432b8f790fa",
"a612e543-2297-49ec-aa59-cf7992ee0b9c"
],
"Opportunities": [
"4503c5ec-c6e7-4dc1-a988-5b9d47d7b820",
"d1b7d301-242a-439e-bffc-1940642d8a5c"
]
}
},
{
"Id": "7e6ead36-757c-4378-a8cb-9b7d89cf00aa",
"SeriesId": "5c2b9dcb-078b-40aa-9961-cb5e5296c5fd",
"AccessorID": "a1282b81-cdc0-4f28-b8a1-fc97159527ef",
"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": "3c6023c5-0955-4c61-9898-971bfe0e226d",
"ScheduledByID": "c4fc1731-b78c-4958-86d0-b1d64bd2a3d4",
"DeletedDates": [
"2026-05-04T00:25:16Z",
"2026-05-04T00:25:16Z"
],
"ClearedDates": [
"2026-05-04T00:25:16Z",
"2026-05-04T00:25:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-04T00:25:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-04T00:25:16Z",
"CreateDate": "2026-05-04T00:25:16Z",
"OccurTime": "2026-05-04T00:25:16Z",
"OccurEndTime": "2026-05-04T00:25:16Z",
"StartTime": "2026-05-04T00:25:16Z",
"EndTime": "2026-05-04T00:25:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c08e9040-7ece-4a87-8af8-162875e5f29d",
"50e1db09-f2d1-4ff2-bd0e-9d6eb0bc8134"
],
"Companies": [
"2e60d74a-8f65-4ad6-90d6-cbbc81e2c159",
"40c0df18-aa45-42f5-8603-cc320d11128e"
],
"Groups": [
"10336c60-370c-47f5-b48a-3432b8f790fa",
"a612e543-2297-49ec-aa59-cf7992ee0b9c"
],
"Opportunities": [
"4503c5ec-c6e7-4dc1-a988-5b9d47d7b820",
"d1b7d301-242a-439e-bffc-1940642d8a5c"
]
}
}
]