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": "49292154-0174-4952-a0ea-22d317af72f8",
"SeriesId": "a67c2f6f-0fdf-409d-9174-f671c2986383",
"AccessorID": "a1c90914-a5b4-41c4-ba59-ce7fde622282",
"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": "599a2149-29dc-4186-a9fe-8cc6bfdb8e73",
"ScheduledByID": "e53088d0-55a4-40b2-982b-516507ae8bb5",
"DeletedDates": [
"2026-10-16T11:49:30Z",
"2026-10-16T11:49:30Z"
],
"ClearedDates": [
"2026-10-16T11:49:30Z",
"2026-10-16T11:49:30Z"
],
"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-16T11:49:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-16T11:49:30Z",
"CreateDate": "2026-10-16T11:49:30Z",
"OccurTime": "2026-10-16T11:49:30Z",
"OccurEndTime": "2026-10-16T11:49:30Z",
"StartTime": "2026-10-16T11:49:30Z",
"EndTime": "2026-10-16T11:49:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"41b404b1-8b16-4bc4-a67d-243667787350",
"66a35661-1a51-4153-99ab-b436f19316be"
],
"Companies": [
"9060e8cd-1828-44e6-82c6-8eaffd2124ab",
"6dadfe87-5e65-468c-b70f-e3d5334b6cee"
],
"Groups": [
"af0785e4-5321-46dd-9c37-d20aad1bd6ad",
"0df436b2-a029-4586-a181-f2107952bbab"
],
"Opportunities": [
"1923e8e6-fcab-48d6-be65-f4f8c1b064eb",
"39fadefe-45eb-4ef1-8680-30daf7a782b2"
]
}
},
{
"Id": "49292154-0174-4952-a0ea-22d317af72f8",
"SeriesId": "a67c2f6f-0fdf-409d-9174-f671c2986383",
"AccessorID": "a1c90914-a5b4-41c4-ba59-ce7fde622282",
"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": "599a2149-29dc-4186-a9fe-8cc6bfdb8e73",
"ScheduledByID": "e53088d0-55a4-40b2-982b-516507ae8bb5",
"DeletedDates": [
"2026-10-16T11:49:30Z",
"2026-10-16T11:49:30Z"
],
"ClearedDates": [
"2026-10-16T11:49:30Z",
"2026-10-16T11:49:30Z"
],
"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-16T11:49:30Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-16T11:49:30Z",
"CreateDate": "2026-10-16T11:49:30Z",
"OccurTime": "2026-10-16T11:49:30Z",
"OccurEndTime": "2026-10-16T11:49:30Z",
"StartTime": "2026-10-16T11:49:30Z",
"EndTime": "2026-10-16T11:49:30Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"41b404b1-8b16-4bc4-a67d-243667787350",
"66a35661-1a51-4153-99ab-b436f19316be"
],
"Companies": [
"9060e8cd-1828-44e6-82c6-8eaffd2124ab",
"6dadfe87-5e65-468c-b70f-e3d5334b6cee"
],
"Groups": [
"af0785e4-5321-46dd-9c37-d20aad1bd6ad",
"0df436b2-a029-4586-a181-f2107952bbab"
],
"Opportunities": [
"1923e8e6-fcab-48d6-be65-f4f8c1b064eb",
"39fadefe-45eb-4ef1-8680-30daf7a782b2"
]
}
}
]