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": "a31ac3d4-ff73-4f3e-ad9f-70a9bfc68c6f",
"SeriesId": "75b330f7-1c68-4207-bca0-c4bed4421a09",
"AccessorID": "94738563-8c26-42ac-aae4-1d8d8de96782",
"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": "9b3e4012-077f-4768-8059-462857745808",
"ScheduledByID": "64423204-8b49-403f-b6a7-254d5381a412",
"DeletedDates": [
"2026-10-31T08:19:07Z",
"2026-10-31T08:19:07Z"
],
"ClearedDates": [
"2026-10-31T08:19:07Z",
"2026-10-31T08:19:07Z"
],
"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-31T08:19:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-31T08:19:07Z",
"CreateDate": "2026-10-31T08:19:07Z",
"OccurTime": "2026-10-31T08:19:07Z",
"OccurEndTime": "2026-10-31T08:19:07Z",
"StartTime": "2026-10-31T08:19:07Z",
"EndTime": "2026-10-31T08:19:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a62881ec-6710-4201-80f7-2fe994232afc",
"39df4ca0-bbf6-40d8-b99c-a46be794c3cc"
],
"Companies": [
"b1e20573-eb37-4c85-890d-d9eaef2b7dcd",
"505ab042-adf5-44c4-8384-41411e373475"
],
"Groups": [
"dc4a89fb-51dc-4010-8b5e-fa84711696ae",
"d758fccb-3957-4b18-867b-ad286f3224ed"
],
"Opportunities": [
"0e5f7f36-c01e-436e-aa5b-88b6dbfd8f91",
"663de953-c9db-44aa-a491-2fa5656e618e"
]
}
},
{
"Id": "a31ac3d4-ff73-4f3e-ad9f-70a9bfc68c6f",
"SeriesId": "75b330f7-1c68-4207-bca0-c4bed4421a09",
"AccessorID": "94738563-8c26-42ac-aae4-1d8d8de96782",
"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": "9b3e4012-077f-4768-8059-462857745808",
"ScheduledByID": "64423204-8b49-403f-b6a7-254d5381a412",
"DeletedDates": [
"2026-10-31T08:19:07Z",
"2026-10-31T08:19:07Z"
],
"ClearedDates": [
"2026-10-31T08:19:07Z",
"2026-10-31T08:19:07Z"
],
"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-31T08:19:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-31T08:19:07Z",
"CreateDate": "2026-10-31T08:19:07Z",
"OccurTime": "2026-10-31T08:19:07Z",
"OccurEndTime": "2026-10-31T08:19:07Z",
"StartTime": "2026-10-31T08:19:07Z",
"EndTime": "2026-10-31T08:19:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a62881ec-6710-4201-80f7-2fe994232afc",
"39df4ca0-bbf6-40d8-b99c-a46be794c3cc"
],
"Companies": [
"b1e20573-eb37-4c85-890d-d9eaef2b7dcd",
"505ab042-adf5-44c4-8384-41411e373475"
],
"Groups": [
"dc4a89fb-51dc-4010-8b5e-fa84711696ae",
"d758fccb-3957-4b18-867b-ad286f3224ed"
],
"Opportunities": [
"0e5f7f36-c01e-436e-aa5b-88b6dbfd8f91",
"663de953-c9db-44aa-a491-2fa5656e618e"
]
}
}
]