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": "886b6906-1c8a-4932-8b46-0bd676d04f0c",
"SeriesId": "8827894c-e141-4bd9-9440-0bd17f2c7bfd",
"AccessorID": "c91806d8-c8fd-4163-9a04-9710a56d6fe0",
"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": "33847550-d11b-4af3-983d-f7b6f824d47e",
"ScheduledByID": "6f956583-f911-4d15-9311-4eb856897f6b",
"DeletedDates": [
"2026-09-17T23:09:01Z",
"2026-09-17T23:09:01Z"
],
"ClearedDates": [
"2026-09-17T23:09:01Z",
"2026-09-17T23:09:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-17T23:09:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-17T23:09:01Z",
"CreateDate": "2026-09-17T23:09:01Z",
"OccurTime": "2026-09-17T23:09:01Z",
"OccurEndTime": "2026-09-17T23:09:01Z",
"StartTime": "2026-09-17T23:09:01Z",
"EndTime": "2026-09-17T23:09:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d6f2b4d-ff92-40b1-911a-535107e0d9aa",
"1744c897-f816-4b8e-a73d-08cfff298d85"
],
"Companies": [
"60666630-8607-4ec3-b99b-2ef6135adf73",
"bd25e43f-8967-44f5-81f7-b4bc2babc90e"
],
"Groups": [
"bd9246a4-f49e-493c-80fc-a7179f488d3f",
"7acc4fed-8b30-4786-b697-c9c792300d29"
],
"Opportunities": [
"f13731ea-f070-4734-bab5-1ef84121e2af",
"8dc8a802-bc71-413b-9239-6f24d654f783"
]
}
},
{
"Id": "886b6906-1c8a-4932-8b46-0bd676d04f0c",
"SeriesId": "8827894c-e141-4bd9-9440-0bd17f2c7bfd",
"AccessorID": "c91806d8-c8fd-4163-9a04-9710a56d6fe0",
"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": "33847550-d11b-4af3-983d-f7b6f824d47e",
"ScheduledByID": "6f956583-f911-4d15-9311-4eb856897f6b",
"DeletedDates": [
"2026-09-17T23:09:01Z",
"2026-09-17T23:09:01Z"
],
"ClearedDates": [
"2026-09-17T23:09:01Z",
"2026-09-17T23:09:01Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-17T23:09:01Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-17T23:09:01Z",
"CreateDate": "2026-09-17T23:09:01Z",
"OccurTime": "2026-09-17T23:09:01Z",
"OccurEndTime": "2026-09-17T23:09:01Z",
"StartTime": "2026-09-17T23:09:01Z",
"EndTime": "2026-09-17T23:09:01Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d6f2b4d-ff92-40b1-911a-535107e0d9aa",
"1744c897-f816-4b8e-a73d-08cfff298d85"
],
"Companies": [
"60666630-8607-4ec3-b99b-2ef6135adf73",
"bd25e43f-8967-44f5-81f7-b4bc2babc90e"
],
"Groups": [
"bd9246a4-f49e-493c-80fc-a7179f488d3f",
"7acc4fed-8b30-4786-b697-c9c792300d29"
],
"Opportunities": [
"f13731ea-f070-4734-bab5-1ef84121e2af",
"8dc8a802-bc71-413b-9239-6f24d654f783"
]
}
}
]