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": "5fdaab60-9c53-4aa2-8d31-8d7ef059692a",
"SeriesId": "9e2bdb6f-c319-4eee-8873-5ef9078b35c7",
"AccessorID": "5dd2311a-fe69-446a-8c85-c14ce6f19b42",
"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": "8520a36d-3e1c-43e9-8cce-1f7124fc912d",
"ScheduledByID": "5ac83171-0984-432d-b3fc-e23970dc05c2",
"DeletedDates": [
"2026-11-17T17:12:44Z",
"2026-11-17T17:12:44Z"
],
"ClearedDates": [
"2026-11-17T17:12:44Z",
"2026-11-17T17:12:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-17T17:12:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-17T17:12:44Z",
"CreateDate": "2026-11-17T17:12:44Z",
"OccurTime": "2026-11-17T17:12:44Z",
"OccurEndTime": "2026-11-17T17:12:44Z",
"StartTime": "2026-11-17T17:12:44Z",
"EndTime": "2026-11-17T17:12:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d947163e-58bd-4467-aa30-c55833cfc4c0",
"ea02227e-a184-4d5f-91bd-312be0dfd998"
],
"Companies": [
"4fe4bea3-19f3-4cef-a477-2c58d982774c",
"db5b0e3d-5691-4aef-a809-ff607afe5c25"
],
"Groups": [
"66abf717-00fe-466b-9da9-0fe035f87901",
"c4278e28-0cae-4e50-800c-5e49e4dbd3b6"
],
"Opportunities": [
"f4160f3c-3840-45e1-b745-2b236d960a2d",
"38463269-1785-42ef-8135-89d0530614e6"
]
}
},
{
"Id": "5fdaab60-9c53-4aa2-8d31-8d7ef059692a",
"SeriesId": "9e2bdb6f-c319-4eee-8873-5ef9078b35c7",
"AccessorID": "5dd2311a-fe69-446a-8c85-c14ce6f19b42",
"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": "8520a36d-3e1c-43e9-8cce-1f7124fc912d",
"ScheduledByID": "5ac83171-0984-432d-b3fc-e23970dc05c2",
"DeletedDates": [
"2026-11-17T17:12:44Z",
"2026-11-17T17:12:44Z"
],
"ClearedDates": [
"2026-11-17T17:12:44Z",
"2026-11-17T17:12:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-17T17:12:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-17T17:12:44Z",
"CreateDate": "2026-11-17T17:12:44Z",
"OccurTime": "2026-11-17T17:12:44Z",
"OccurEndTime": "2026-11-17T17:12:44Z",
"StartTime": "2026-11-17T17:12:44Z",
"EndTime": "2026-11-17T17:12:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d947163e-58bd-4467-aa30-c55833cfc4c0",
"ea02227e-a184-4d5f-91bd-312be0dfd998"
],
"Companies": [
"4fe4bea3-19f3-4cef-a477-2c58d982774c",
"db5b0e3d-5691-4aef-a809-ff607afe5c25"
],
"Groups": [
"66abf717-00fe-466b-9da9-0fe035f87901",
"c4278e28-0cae-4e50-800c-5e49e4dbd3b6"
],
"Opportunities": [
"f4160f3c-3840-45e1-b745-2b236d960a2d",
"38463269-1785-42ef-8135-89d0530614e6"
]
}
}
]