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": "f8f9914b-f99d-4e91-8ec7-7bbb5d1c68bf",
"SeriesId": "28fd57b9-6c98-4c8c-8a2d-7cda6e853f6c",
"AccessorID": "a937c39a-fe26-4f6a-ad19-d993ce8f70a9",
"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": "b46cee4f-f12f-4c5f-9a2d-612f80ac32b2",
"ScheduledByID": "66ac04df-fe0f-400d-987f-a7d2ce597010",
"DeletedDates": [
"2026-06-28T11:27:57Z",
"2026-06-28T11:27:57Z"
],
"ClearedDates": [
"2026-06-28T11:27:57Z",
"2026-06-28T11:27:57Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-28T11:27:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-28T11:27:57Z",
"CreateDate": "2026-06-28T11:27:57Z",
"OccurTime": "2026-06-28T11:27:57Z",
"OccurEndTime": "2026-06-28T11:27:57Z",
"StartTime": "2026-06-28T11:27:57Z",
"EndTime": "2026-06-28T11:27:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efd418b2-c1d3-4fd9-9fb6-aef8e7009a02",
"91c8022a-f999-463e-83a9-19df196e3ffb"
],
"Companies": [
"a9ff1d39-f486-4d69-98b9-510374c0a2fb",
"9a6a92a7-5bc7-4e4d-aa55-9f2c903bff83"
],
"Groups": [
"55d5d5e1-f35b-43ad-89fb-b1bdceb9a27d",
"f383d6fa-ce4a-4fac-bb88-c08f5c918709"
],
"Opportunities": [
"e326582b-be1b-4d4e-96b8-033da338053c",
"cdf3f739-1321-444a-8fe8-eade9f95292b"
]
}
},
{
"Id": "f8f9914b-f99d-4e91-8ec7-7bbb5d1c68bf",
"SeriesId": "28fd57b9-6c98-4c8c-8a2d-7cda6e853f6c",
"AccessorID": "a937c39a-fe26-4f6a-ad19-d993ce8f70a9",
"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": "b46cee4f-f12f-4c5f-9a2d-612f80ac32b2",
"ScheduledByID": "66ac04df-fe0f-400d-987f-a7d2ce597010",
"DeletedDates": [
"2026-06-28T11:27:57Z",
"2026-06-28T11:27:57Z"
],
"ClearedDates": [
"2026-06-28T11:27:57Z",
"2026-06-28T11:27:57Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-28T11:27:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-28T11:27:57Z",
"CreateDate": "2026-06-28T11:27:57Z",
"OccurTime": "2026-06-28T11:27:57Z",
"OccurEndTime": "2026-06-28T11:27:57Z",
"StartTime": "2026-06-28T11:27:57Z",
"EndTime": "2026-06-28T11:27:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efd418b2-c1d3-4fd9-9fb6-aef8e7009a02",
"91c8022a-f999-463e-83a9-19df196e3ffb"
],
"Companies": [
"a9ff1d39-f486-4d69-98b9-510374c0a2fb",
"9a6a92a7-5bc7-4e4d-aa55-9f2c903bff83"
],
"Groups": [
"55d5d5e1-f35b-43ad-89fb-b1bdceb9a27d",
"f383d6fa-ce4a-4fac-bb88-c08f5c918709"
],
"Opportunities": [
"e326582b-be1b-4d4e-96b8-033da338053c",
"cdf3f739-1321-444a-8fe8-eade9f95292b"
]
}
}
]