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": "eadc9931-92e3-4878-8aaf-f291121140be",
"SeriesId": "3fc960e6-e975-45e4-a5f4-76e439c1f51c",
"AccessorID": "730df140-2154-462a-8ce4-498965002772",
"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": "73d91452-20e5-464b-8c36-91ad457324ca",
"ScheduledByID": "20447d8c-9244-4eec-8337-fd5b0ead5e69",
"DeletedDates": [
"2026-07-28T14:33:17Z",
"2026-07-28T14:33:17Z"
],
"ClearedDates": [
"2026-07-28T14:33:17Z",
"2026-07-28T14:33:17Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-28T14:33:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-28T14:33:17Z",
"CreateDate": "2026-07-28T14:33:17Z",
"OccurTime": "2026-07-28T14:33:17Z",
"OccurEndTime": "2026-07-28T14:33:17Z",
"StartTime": "2026-07-28T14:33:17Z",
"EndTime": "2026-07-28T14:33:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"fc6fe1ea-9d8c-4c20-8f14-09728bba5018",
"fc050ad4-30b9-4e5d-a120-a9a8175f33d8"
],
"Companies": [
"3b42352a-ca5e-4325-9fc0-7a6964b0e968",
"251ccbf3-c7f8-409d-9388-dd217e846bb7"
],
"Groups": [
"2e126c4b-d8ca-4b85-a8d6-19f9c4575ecb",
"cf78c4ff-2c8a-44df-a478-b17b9f53fe93"
],
"Opportunities": [
"281862fc-7ae1-491c-8fd1-56ceaf6a511d",
"5409b93f-ce63-4f84-85d7-0b661453442c"
]
}
},
{
"Id": "eadc9931-92e3-4878-8aaf-f291121140be",
"SeriesId": "3fc960e6-e975-45e4-a5f4-76e439c1f51c",
"AccessorID": "730df140-2154-462a-8ce4-498965002772",
"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": "73d91452-20e5-464b-8c36-91ad457324ca",
"ScheduledByID": "20447d8c-9244-4eec-8337-fd5b0ead5e69",
"DeletedDates": [
"2026-07-28T14:33:17Z",
"2026-07-28T14:33:17Z"
],
"ClearedDates": [
"2026-07-28T14:33:17Z",
"2026-07-28T14:33:17Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-28T14:33:17Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-28T14:33:17Z",
"CreateDate": "2026-07-28T14:33:17Z",
"OccurTime": "2026-07-28T14:33:17Z",
"OccurEndTime": "2026-07-28T14:33:17Z",
"StartTime": "2026-07-28T14:33:17Z",
"EndTime": "2026-07-28T14:33:17Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"fc6fe1ea-9d8c-4c20-8f14-09728bba5018",
"fc050ad4-30b9-4e5d-a120-a9a8175f33d8"
],
"Companies": [
"3b42352a-ca5e-4325-9fc0-7a6964b0e968",
"251ccbf3-c7f8-409d-9388-dd217e846bb7"
],
"Groups": [
"2e126c4b-d8ca-4b85-a8d6-19f9c4575ecb",
"cf78c4ff-2c8a-44df-a478-b17b9f53fe93"
],
"Opportunities": [
"281862fc-7ae1-491c-8fd1-56ceaf6a511d",
"5409b93f-ce63-4f84-85d7-0b661453442c"
]
}
}
]