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": "70fafb81-e687-47ce-bde5-73afdfded284",
"SeriesId": "22e0c5c6-bb5e-4008-9037-ff63f387a7fc",
"AccessorID": "640d8bc1-276e-47d4-bd3c-a638a837150d",
"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": "7cbb2e00-ff76-47dd-9695-4814ff4c0ec3",
"ScheduledByID": "23a568e9-e37a-4986-bff3-bdc7917f61b1",
"DeletedDates": [
"2026-04-27T09:31:20Z",
"2026-04-27T09:31:20Z"
],
"ClearedDates": [
"2026-04-27T09:31:20Z",
"2026-04-27T09:31:20Z"
],
"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-27T09:31:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T09:31:20Z",
"CreateDate": "2026-04-27T09:31:20Z",
"OccurTime": "2026-04-27T09:31:20Z",
"OccurEndTime": "2026-04-27T09:31:20Z",
"StartTime": "2026-04-27T09:31:20Z",
"EndTime": "2026-04-27T09:31:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9ea241bb-03e2-481b-8855-ef325d73465d",
"9dec4917-15fb-4ccb-a7e1-ba1e5c463163"
],
"Companies": [
"fb702feb-b6a8-41db-8d01-92a05c7b003d",
"4f037e0b-1f43-43e2-8fb8-9d672f4f4b60"
],
"Groups": [
"572630cd-afd9-4042-9f5c-e96d86aced47",
"a4512d7c-27da-4b39-8744-db3b8d2244ed"
],
"Opportunities": [
"c3195cb8-7df9-46da-8ab6-23a5dacd8976",
"0f09b615-9bcb-464b-af84-e22c1fda887f"
]
}
},
{
"Id": "70fafb81-e687-47ce-bde5-73afdfded284",
"SeriesId": "22e0c5c6-bb5e-4008-9037-ff63f387a7fc",
"AccessorID": "640d8bc1-276e-47d4-bd3c-a638a837150d",
"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": "7cbb2e00-ff76-47dd-9695-4814ff4c0ec3",
"ScheduledByID": "23a568e9-e37a-4986-bff3-bdc7917f61b1",
"DeletedDates": [
"2026-04-27T09:31:20Z",
"2026-04-27T09:31:20Z"
],
"ClearedDates": [
"2026-04-27T09:31:20Z",
"2026-04-27T09:31:20Z"
],
"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-27T09:31:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-27T09:31:20Z",
"CreateDate": "2026-04-27T09:31:20Z",
"OccurTime": "2026-04-27T09:31:20Z",
"OccurEndTime": "2026-04-27T09:31:20Z",
"StartTime": "2026-04-27T09:31:20Z",
"EndTime": "2026-04-27T09:31:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9ea241bb-03e2-481b-8855-ef325d73465d",
"9dec4917-15fb-4ccb-a7e1-ba1e5c463163"
],
"Companies": [
"fb702feb-b6a8-41db-8d01-92a05c7b003d",
"4f037e0b-1f43-43e2-8fb8-9d672f4f4b60"
],
"Groups": [
"572630cd-afd9-4042-9f5c-e96d86aced47",
"a4512d7c-27da-4b39-8744-db3b8d2244ed"
],
"Opportunities": [
"c3195cb8-7df9-46da-8ab6-23a5dacd8976",
"0f09b615-9bcb-464b-af84-e22c1fda887f"
]
}
}
]