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": "d8d4b8d9-6bb5-4be4-9b9f-8fe82874a7b0",
"SeriesId": "2e89ab80-93cb-402b-9490-7a85a84c1e79",
"AccessorID": "ccc2a0b8-baf7-4207-8826-3e7091875e97",
"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": "61a287da-a14a-49c0-abaf-8735e5189560",
"ScheduledByID": "6bef8a68-ba4f-4019-b197-e063cf549bd2",
"DeletedDates": [
"2026-08-14T06:00:04Z",
"2026-08-14T06:00:04Z"
],
"ClearedDates": [
"2026-08-14T06:00:04Z",
"2026-08-14T06:00:04Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-14T06:00:04Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-14T06:00:04Z",
"CreateDate": "2026-08-14T06:00:04Z",
"OccurTime": "2026-08-14T06:00:04Z",
"OccurEndTime": "2026-08-14T06:00:04Z",
"StartTime": "2026-08-14T06:00:04Z",
"EndTime": "2026-08-14T06:00:04Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c1baef80-317d-441d-b78d-13ba2a3ba865",
"182c51d8-1660-4ddc-bb5e-ea74c6399b17"
],
"Companies": [
"c4a4db1d-6921-41c3-9c6b-78960f7e0534",
"4c65a426-d224-411d-ba69-f0bab014474e"
],
"Groups": [
"e4ebb580-188c-46bd-9dd8-841862ae26aa",
"4babf9db-44b0-4550-8d4f-6435e8805bd8"
],
"Opportunities": [
"3772b5cf-50df-462a-b68f-e2dd862f3726",
"b72acd10-6382-44bc-9d11-c6c4b02207ed"
]
}
},
{
"Id": "d8d4b8d9-6bb5-4be4-9b9f-8fe82874a7b0",
"SeriesId": "2e89ab80-93cb-402b-9490-7a85a84c1e79",
"AccessorID": "ccc2a0b8-baf7-4207-8826-3e7091875e97",
"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": "61a287da-a14a-49c0-abaf-8735e5189560",
"ScheduledByID": "6bef8a68-ba4f-4019-b197-e063cf549bd2",
"DeletedDates": [
"2026-08-14T06:00:04Z",
"2026-08-14T06:00:04Z"
],
"ClearedDates": [
"2026-08-14T06:00:04Z",
"2026-08-14T06:00:04Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-14T06:00:04Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-14T06:00:04Z",
"CreateDate": "2026-08-14T06:00:04Z",
"OccurTime": "2026-08-14T06:00:04Z",
"OccurEndTime": "2026-08-14T06:00:04Z",
"StartTime": "2026-08-14T06:00:04Z",
"EndTime": "2026-08-14T06:00:04Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c1baef80-317d-441d-b78d-13ba2a3ba865",
"182c51d8-1660-4ddc-bb5e-ea74c6399b17"
],
"Companies": [
"c4a4db1d-6921-41c3-9c6b-78960f7e0534",
"4c65a426-d224-411d-ba69-f0bab014474e"
],
"Groups": [
"e4ebb580-188c-46bd-9dd8-841862ae26aa",
"4babf9db-44b0-4550-8d4f-6435e8805bd8"
],
"Opportunities": [
"3772b5cf-50df-462a-b68f-e2dd862f3726",
"b72acd10-6382-44bc-9d11-c6c4b02207ed"
]
}
}
]