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": "c354403d-e060-467f-affc-d88a2a71985b",
"SeriesId": "4c95e7f8-5a85-4c56-bf13-c4faba31eed5",
"AccessorID": "5b718167-2445-4de0-bdc0-3cc95bfe8ec8",
"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": "384a9912-d0e9-4bba-9303-ec85a13b0f5b",
"ScheduledByID": "d57ea228-7cd3-4ef3-8555-e666944beaec",
"DeletedDates": [
"2025-12-15T10:24:27Z",
"2025-12-15T10:24:27Z"
],
"ClearedDates": [
"2025-12-15T10:24:27Z",
"2025-12-15T10:24:27Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-15T10:24:27Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-15T10:24:27Z",
"CreateDate": "2025-12-15T10:24:27Z",
"OccurTime": "2025-12-15T10:24:27Z",
"OccurEndTime": "2025-12-15T10:24:27Z",
"StartTime": "2025-12-15T10:24:27Z",
"EndTime": "2025-12-15T10:24:27Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a1090168-fe5e-42c6-b6a9-2cf0bbfe18ac",
"aa2d1e02-ddea-466d-ab48-f74ed77abb29"
],
"Companies": [
"daa4147b-fb1e-40d4-9bd3-1472f2f2ab50",
"6c037ab8-5cc6-43cd-8f4e-4d5cae71e4d3"
],
"Groups": [
"f994d93f-182c-4a89-9510-f714ebb32fda",
"f7e5cc3b-e913-45d6-9e26-9bc3548c44f7"
],
"Opportunities": [
"bd40da4f-91ec-4eb2-b17f-74d385d0f35c",
"e7892c73-320b-4b70-9732-f6b0edafae30"
]
}
},
{
"Id": "c354403d-e060-467f-affc-d88a2a71985b",
"SeriesId": "4c95e7f8-5a85-4c56-bf13-c4faba31eed5",
"AccessorID": "5b718167-2445-4de0-bdc0-3cc95bfe8ec8",
"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": "384a9912-d0e9-4bba-9303-ec85a13b0f5b",
"ScheduledByID": "d57ea228-7cd3-4ef3-8555-e666944beaec",
"DeletedDates": [
"2025-12-15T10:24:27Z",
"2025-12-15T10:24:27Z"
],
"ClearedDates": [
"2025-12-15T10:24:27Z",
"2025-12-15T10:24:27Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-12-15T10:24:27Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-12-15T10:24:27Z",
"CreateDate": "2025-12-15T10:24:27Z",
"OccurTime": "2025-12-15T10:24:27Z",
"OccurEndTime": "2025-12-15T10:24:27Z",
"StartTime": "2025-12-15T10:24:27Z",
"EndTime": "2025-12-15T10:24:27Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a1090168-fe5e-42c6-b6a9-2cf0bbfe18ac",
"aa2d1e02-ddea-466d-ab48-f74ed77abb29"
],
"Companies": [
"daa4147b-fb1e-40d4-9bd3-1472f2f2ab50",
"6c037ab8-5cc6-43cd-8f4e-4d5cae71e4d3"
],
"Groups": [
"f994d93f-182c-4a89-9510-f714ebb32fda",
"f7e5cc3b-e913-45d6-9e26-9bc3548c44f7"
],
"Opportunities": [
"bd40da4f-91ec-4eb2-b17f-74d385d0f35c",
"e7892c73-320b-4b70-9732-f6b0edafae30"
]
}
}
]