GET api/Activities
Get all activities matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeClearedDates, IncludeDeletedDates, DetailFormat
Request Information
URI Parameters
None.
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": "ac6f0641-44ec-43ba-97d7-24de7893e3f2",
"SeriesId": "3527e137-99ee-4582-84cc-ad0657e23590",
"AccessorID": "89ef38e0-be64-4196-bd7d-e72123967c0c",
"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": "a4a2aef9-40a9-4120-b315-39054e2c5a77",
"ScheduledByID": "71c37b23-2417-480e-93fc-65df38ff5220",
"DeletedDates": [
"2026-06-18T01:24:52Z",
"2026-06-18T01:24:52Z"
],
"ClearedDates": [
"2026-06-18T01:24:52Z",
"2026-06-18T01:24:52Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-18T01:24:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-18T01:24:52Z",
"CreateDate": "2026-06-18T01:24:52Z",
"OccurTime": "2026-06-18T01:24:52Z",
"OccurEndTime": "2026-06-18T01:24:52Z",
"StartTime": "2026-06-18T01:24:52Z",
"EndTime": "2026-06-18T01:24:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"88be0b42-0e21-4f9c-b1a5-9b888136945d",
"8a6e9558-fc70-49b4-801a-e51771704383"
],
"Companies": [
"949d0928-6dfc-48b9-b83a-d2d605227a11",
"15c511c8-21b0-4f98-930d-a16c82c05b96"
],
"Groups": [
"29958b9c-1378-436c-8b1d-993fd461e2d4",
"77ad92db-6737-4abe-8d60-7b53c39c859f"
],
"Opportunities": [
"b534add0-10c9-4e94-ae9e-a5e0fbcc2727",
"a18441c6-3428-469f-a547-73fffaa8681e"
]
}
},
{
"Id": "ac6f0641-44ec-43ba-97d7-24de7893e3f2",
"SeriesId": "3527e137-99ee-4582-84cc-ad0657e23590",
"AccessorID": "89ef38e0-be64-4196-bd7d-e72123967c0c",
"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": "a4a2aef9-40a9-4120-b315-39054e2c5a77",
"ScheduledByID": "71c37b23-2417-480e-93fc-65df38ff5220",
"DeletedDates": [
"2026-06-18T01:24:52Z",
"2026-06-18T01:24:52Z"
],
"ClearedDates": [
"2026-06-18T01:24:52Z",
"2026-06-18T01:24:52Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-18T01:24:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-18T01:24:52Z",
"CreateDate": "2026-06-18T01:24:52Z",
"OccurTime": "2026-06-18T01:24:52Z",
"OccurEndTime": "2026-06-18T01:24:52Z",
"StartTime": "2026-06-18T01:24:52Z",
"EndTime": "2026-06-18T01:24:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"88be0b42-0e21-4f9c-b1a5-9b888136945d",
"8a6e9558-fc70-49b4-801a-e51771704383"
],
"Companies": [
"949d0928-6dfc-48b9-b83a-d2d605227a11",
"15c511c8-21b0-4f98-930d-a16c82c05b96"
],
"Groups": [
"29958b9c-1378-436c-8b1d-993fd461e2d4",
"77ad92db-6737-4abe-8d60-7b53c39c859f"
],
"Opportunities": [
"b534add0-10c9-4e94-ae9e-a5e0fbcc2727",
"a18441c6-3428-469f-a547-73fffaa8681e"
]
}
}
]