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": "bfeecc23-8349-4879-8f3c-52120e7d5bb7",
"SeriesId": "48ab6003-8aad-44fa-b7e9-afda0c09ef65",
"AccessorID": "5cac1722-efff-4a63-8317-c52aee78f249",
"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": "698e2fe3-0270-4004-9c4c-c06b35742015",
"ScheduledByID": "99f77707-8f7b-4efa-a0f6-05a9075ccd43",
"DeletedDates": [
"2026-06-05T16:38:10Z",
"2026-06-05T16:38:10Z"
],
"ClearedDates": [
"2026-06-05T16:38:10Z",
"2026-06-05T16:38:10Z"
],
"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-05T16:38:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-05T16:38:10Z",
"CreateDate": "2026-06-05T16:38:10Z",
"OccurTime": "2026-06-05T16:38:10Z",
"OccurEndTime": "2026-06-05T16:38:10Z",
"StartTime": "2026-06-05T16:38:10Z",
"EndTime": "2026-06-05T16:38:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18e8ff02-e82e-49c7-9851-5ed09fca38fb",
"9aa71fc9-531d-49fa-b841-f25436340148"
],
"Companies": [
"5435ed1e-c3fb-42c7-b5a2-fd345fbad11a",
"d1047184-e541-42dc-9ea3-6283db2af20f"
],
"Groups": [
"57238124-84e8-4227-93dc-7cadf920db74",
"7c7f9ced-dab1-4afb-be66-03ecb19f8016"
],
"Opportunities": [
"78e4018b-5011-458e-bff9-1c46ecc7ec9e",
"28902019-97aa-4a72-b8ae-4fe5fe3385bb"
]
}
},
{
"Id": "bfeecc23-8349-4879-8f3c-52120e7d5bb7",
"SeriesId": "48ab6003-8aad-44fa-b7e9-afda0c09ef65",
"AccessorID": "5cac1722-efff-4a63-8317-c52aee78f249",
"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": "698e2fe3-0270-4004-9c4c-c06b35742015",
"ScheduledByID": "99f77707-8f7b-4efa-a0f6-05a9075ccd43",
"DeletedDates": [
"2026-06-05T16:38:10Z",
"2026-06-05T16:38:10Z"
],
"ClearedDates": [
"2026-06-05T16:38:10Z",
"2026-06-05T16:38:10Z"
],
"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-05T16:38:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-05T16:38:10Z",
"CreateDate": "2026-06-05T16:38:10Z",
"OccurTime": "2026-06-05T16:38:10Z",
"OccurEndTime": "2026-06-05T16:38:10Z",
"StartTime": "2026-06-05T16:38:10Z",
"EndTime": "2026-06-05T16:38:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18e8ff02-e82e-49c7-9851-5ed09fca38fb",
"9aa71fc9-531d-49fa-b841-f25436340148"
],
"Companies": [
"5435ed1e-c3fb-42c7-b5a2-fd345fbad11a",
"d1047184-e541-42dc-9ea3-6283db2af20f"
],
"Groups": [
"57238124-84e8-4227-93dc-7cadf920db74",
"7c7f9ced-dab1-4afb-be66-03ecb19f8016"
],
"Opportunities": [
"78e4018b-5011-458e-bff9-1c46ecc7ec9e",
"28902019-97aa-4a72-b8ae-4fe5fe3385bb"
]
}
}
]