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": "9828c29b-a821-4170-957f-b568ab848783",
"SeriesId": "6f1a8260-4387-4494-8b54-21a97cbfc05d",
"AccessorID": "abed5627-55d3-46cf-80ac-82dd8e5e0954",
"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": "40eacc85-67c9-49f6-8d84-4eebcbb03942",
"ScheduledByID": "2ac8d81c-86c4-4df0-815c-7caadd0c033f",
"DeletedDates": [
"2025-11-19T20:15:20Z",
"2025-11-19T20:15:20Z"
],
"ClearedDates": [
"2025-11-19T20:15:20Z",
"2025-11-19T20:15:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-19T20:15:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-19T20:15:20Z",
"CreateDate": "2025-11-19T20:15:20Z",
"OccurTime": "2025-11-19T20:15:20Z",
"OccurEndTime": "2025-11-19T20:15:20Z",
"StartTime": "2025-11-19T20:15:20Z",
"EndTime": "2025-11-19T20:15:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"97913478-2fc8-405a-b5fc-f5bed710d928",
"f771ba41-3a68-4f62-a3f1-e3610a27e37f"
],
"Companies": [
"df087240-1176-470e-9fa1-a0479b793691",
"8a13ebb4-72ea-4481-894e-35d5568ce32a"
],
"Groups": [
"0cf027ed-df60-4154-b551-9b1f02c6a733",
"510cf05f-624d-460f-9d5f-740e6968e282"
],
"Opportunities": [
"f72c08dc-97f9-48ff-a0dd-1e68a21a9d93",
"38b9031a-be46-4822-9438-1b0fefcf4882"
]
}
},
{
"Id": "9828c29b-a821-4170-957f-b568ab848783",
"SeriesId": "6f1a8260-4387-4494-8b54-21a97cbfc05d",
"AccessorID": "abed5627-55d3-46cf-80ac-82dd8e5e0954",
"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": "40eacc85-67c9-49f6-8d84-4eebcbb03942",
"ScheduledByID": "2ac8d81c-86c4-4df0-815c-7caadd0c033f",
"DeletedDates": [
"2025-11-19T20:15:20Z",
"2025-11-19T20:15:20Z"
],
"ClearedDates": [
"2025-11-19T20:15:20Z",
"2025-11-19T20:15:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-19T20:15:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-19T20:15:20Z",
"CreateDate": "2025-11-19T20:15:20Z",
"OccurTime": "2025-11-19T20:15:20Z",
"OccurEndTime": "2025-11-19T20:15:20Z",
"StartTime": "2025-11-19T20:15:20Z",
"EndTime": "2025-11-19T20:15:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"97913478-2fc8-405a-b5fc-f5bed710d928",
"f771ba41-3a68-4f62-a3f1-e3610a27e37f"
],
"Companies": [
"df087240-1176-470e-9fa1-a0479b793691",
"8a13ebb4-72ea-4481-894e-35d5568ce32a"
],
"Groups": [
"0cf027ed-df60-4154-b551-9b1f02c6a733",
"510cf05f-624d-460f-9d5f-740e6968e282"
],
"Opportunities": [
"f72c08dc-97f9-48ff-a0dd-1e68a21a9d93",
"38b9031a-be46-4822-9438-1b0fefcf4882"
]
}
}
]