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": "3f83e5c2-8530-4b61-9d71-78160f9e4f86",
"SeriesId": "988f6531-3ab1-44a5-af1f-d9ab9d131113",
"AccessorID": "6330bd73-5d33-4fd8-b983-9e56b93f73a8",
"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": "fb4ad1bf-cc82-458d-82db-e098d53bef9f",
"ScheduledByID": "44313ff4-5608-42c7-a288-f50492c768e1",
"DeletedDates": [
"2026-08-31T18:21:00Z",
"2026-08-31T18:21:00Z"
],
"ClearedDates": [
"2026-08-31T18:21:00Z",
"2026-08-31T18:21:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-31T18:21:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-31T18:21:00Z",
"CreateDate": "2026-08-31T18:21:00Z",
"OccurTime": "2026-08-31T18:21:00Z",
"OccurEndTime": "2026-08-31T18:21:00Z",
"StartTime": "2026-08-31T18:21:00Z",
"EndTime": "2026-08-31T18:21:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"37d47f88-f31b-49a4-9644-b2ee46e149b4",
"a521b844-c9cd-45d9-8b69-49b1c8c73e4d"
],
"Companies": [
"eeee9427-905b-49ac-b50b-0b3a24dff538",
"a7e98dd1-c18d-4ccb-bfb7-099337adcdc4"
],
"Groups": [
"8a5550e2-5102-4cd6-af90-4371a6bd66af",
"18c45f41-c168-4b80-bf1e-38e870ad5371"
],
"Opportunities": [
"19209245-a1bd-4081-95e5-6a8b4da7de1b",
"0eaa90d7-9927-4f9a-8056-6345b2d96f27"
]
}
},
{
"Id": "3f83e5c2-8530-4b61-9d71-78160f9e4f86",
"SeriesId": "988f6531-3ab1-44a5-af1f-d9ab9d131113",
"AccessorID": "6330bd73-5d33-4fd8-b983-9e56b93f73a8",
"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": "fb4ad1bf-cc82-458d-82db-e098d53bef9f",
"ScheduledByID": "44313ff4-5608-42c7-a288-f50492c768e1",
"DeletedDates": [
"2026-08-31T18:21:00Z",
"2026-08-31T18:21:00Z"
],
"ClearedDates": [
"2026-08-31T18:21:00Z",
"2026-08-31T18:21:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-31T18:21:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-31T18:21:00Z",
"CreateDate": "2026-08-31T18:21:00Z",
"OccurTime": "2026-08-31T18:21:00Z",
"OccurEndTime": "2026-08-31T18:21:00Z",
"StartTime": "2026-08-31T18:21:00Z",
"EndTime": "2026-08-31T18:21:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"37d47f88-f31b-49a4-9644-b2ee46e149b4",
"a521b844-c9cd-45d9-8b69-49b1c8c73e4d"
],
"Companies": [
"eeee9427-905b-49ac-b50b-0b3a24dff538",
"a7e98dd1-c18d-4ccb-bfb7-099337adcdc4"
],
"Groups": [
"8a5550e2-5102-4cd6-af90-4371a6bd66af",
"18c45f41-c168-4b80-bf1e-38e870ad5371"
],
"Opportunities": [
"19209245-a1bd-4081-95e5-6a8b4da7de1b",
"0eaa90d7-9927-4f9a-8056-6345b2d96f27"
]
}
}
]