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": "8b07e223-043c-4347-9b5a-8eb974e99787",
"SeriesId": "fa0f540c-fdfe-48e5-b932-4e5c9b6da206",
"AccessorID": "da956ab6-0e27-4c4f-94f8-776c47a78b76",
"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": "d71db661-c7a9-4fd2-a9ab-2d76d38033e0",
"ScheduledByID": "fe637f95-af60-402b-a5c7-3cd68a1ae0c7",
"DeletedDates": [
"2026-02-28T22:41:08Z",
"2026-02-28T22:41:08Z"
],
"ClearedDates": [
"2026-02-28T22:41:08Z",
"2026-02-28T22:41:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T22:41:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T22:41:08Z",
"CreateDate": "2026-02-28T22:41:08Z",
"OccurTime": "2026-02-28T22:41:08Z",
"OccurEndTime": "2026-02-28T22:41:08Z",
"StartTime": "2026-02-28T22:41:08Z",
"EndTime": "2026-02-28T22:41:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7d678d21-bb2b-41ac-817e-7339b9fd2440",
"3c1c6c89-8457-4430-80b1-47df00a23294"
],
"Companies": [
"53a1b9d0-adaa-4696-bdbd-5f62e1f1cc62",
"95215a58-6675-4640-a6b3-9e2a657ed00e"
],
"Groups": [
"0d0d19d5-2fd3-4e58-a5e7-714aaafb117c",
"01f4eb5b-818c-49b7-b83f-af4b8c876b89"
],
"Opportunities": [
"34f02643-247b-462e-906f-935ea5c9d088",
"d06278fe-745f-4fc0-b977-6ab5bc7dff52"
]
}
},
{
"Id": "8b07e223-043c-4347-9b5a-8eb974e99787",
"SeriesId": "fa0f540c-fdfe-48e5-b932-4e5c9b6da206",
"AccessorID": "da956ab6-0e27-4c4f-94f8-776c47a78b76",
"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": "d71db661-c7a9-4fd2-a9ab-2d76d38033e0",
"ScheduledByID": "fe637f95-af60-402b-a5c7-3cd68a1ae0c7",
"DeletedDates": [
"2026-02-28T22:41:08Z",
"2026-02-28T22:41:08Z"
],
"ClearedDates": [
"2026-02-28T22:41:08Z",
"2026-02-28T22:41:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-02-28T22:41:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-02-28T22:41:08Z",
"CreateDate": "2026-02-28T22:41:08Z",
"OccurTime": "2026-02-28T22:41:08Z",
"OccurEndTime": "2026-02-28T22:41:08Z",
"StartTime": "2026-02-28T22:41:08Z",
"EndTime": "2026-02-28T22:41:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7d678d21-bb2b-41ac-817e-7339b9fd2440",
"3c1c6c89-8457-4430-80b1-47df00a23294"
],
"Companies": [
"53a1b9d0-adaa-4696-bdbd-5f62e1f1cc62",
"95215a58-6675-4640-a6b3-9e2a657ed00e"
],
"Groups": [
"0d0d19d5-2fd3-4e58-a5e7-714aaafb117c",
"01f4eb5b-818c-49b7-b83f-af4b8c876b89"
],
"Opportunities": [
"34f02643-247b-462e-906f-935ea5c9d088",
"d06278fe-745f-4fc0-b977-6ab5bc7dff52"
]
}
}
]