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": "b459a45d-8ef2-4ce4-b745-b24270875bc0",
"SeriesId": "725b1923-06e4-4276-8e1f-7abf7044aa8e",
"AccessorID": "08d1613b-c731-4c4e-ba25-d4f046986906",
"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": "4fcc87bb-775a-4f1d-869e-91502d1d9bf4",
"ScheduledByID": "7818c37e-7c81-4aa9-951a-d4ff8b730e12",
"DeletedDates": [
"2026-10-02T03:03:25Z",
"2026-10-02T03:03:25Z"
],
"ClearedDates": [
"2026-10-02T03:03:25Z",
"2026-10-02T03:03:25Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-02T03:03:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-02T03:03:25Z",
"CreateDate": "2026-10-02T03:03:25Z",
"OccurTime": "2026-10-02T03:03:25Z",
"OccurEndTime": "2026-10-02T03:03:25Z",
"StartTime": "2026-10-02T03:03:25Z",
"EndTime": "2026-10-02T03:03:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f4b64c09-4aaa-473b-8a43-645477ea2b5a",
"7bd3aa2f-77bc-4763-88fa-c352fab642ea"
],
"Companies": [
"acb72a27-c670-4757-b473-3bbecf742eac",
"32253fbb-e2e8-4be7-96c5-bb80c8c38933"
],
"Groups": [
"8bf1f8d3-0dd3-4a91-bef8-da813110afda",
"ad8259c9-e097-473f-8ce6-14d99bcfee1a"
],
"Opportunities": [
"f873f50b-2b27-4c57-944c-9faf6be60fe0",
"f826f53a-c256-48d0-b346-556c7f16a63f"
]
}
},
{
"Id": "b459a45d-8ef2-4ce4-b745-b24270875bc0",
"SeriesId": "725b1923-06e4-4276-8e1f-7abf7044aa8e",
"AccessorID": "08d1613b-c731-4c4e-ba25-d4f046986906",
"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": "4fcc87bb-775a-4f1d-869e-91502d1d9bf4",
"ScheduledByID": "7818c37e-7c81-4aa9-951a-d4ff8b730e12",
"DeletedDates": [
"2026-10-02T03:03:25Z",
"2026-10-02T03:03:25Z"
],
"ClearedDates": [
"2026-10-02T03:03:25Z",
"2026-10-02T03:03:25Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-02T03:03:25Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-02T03:03:25Z",
"CreateDate": "2026-10-02T03:03:25Z",
"OccurTime": "2026-10-02T03:03:25Z",
"OccurEndTime": "2026-10-02T03:03:25Z",
"StartTime": "2026-10-02T03:03:25Z",
"EndTime": "2026-10-02T03:03:25Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f4b64c09-4aaa-473b-8a43-645477ea2b5a",
"7bd3aa2f-77bc-4763-88fa-c352fab642ea"
],
"Companies": [
"acb72a27-c670-4757-b473-3bbecf742eac",
"32253fbb-e2e8-4be7-96c5-bb80c8c38933"
],
"Groups": [
"8bf1f8d3-0dd3-4a91-bef8-da813110afda",
"ad8259c9-e097-473f-8ce6-14d99bcfee1a"
],
"Opportunities": [
"f873f50b-2b27-4c57-944c-9faf6be60fe0",
"f826f53a-c256-48d0-b346-556c7f16a63f"
]
}
}
]