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": "59e8fbb5-5d14-4086-981b-deb3b45df495",
"SeriesId": "0874f203-caa2-417c-836e-013e962a3711",
"AccessorID": "a5911e50-2c28-4be2-87cf-dc2c86fdddb9",
"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": "41d8f6a6-c63a-419b-a504-b8373a968049",
"ScheduledByID": "ea8bbddc-bc74-4005-9858-0f8d44a396cd",
"DeletedDates": [
"2026-09-26T20:46:59Z",
"2026-09-26T20:46:59Z"
],
"ClearedDates": [
"2026-09-26T20:46:59Z",
"2026-09-26T20:46:59Z"
],
"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-26T20:46:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-26T20:46:59Z",
"CreateDate": "2026-09-26T20:46:59Z",
"OccurTime": "2026-09-26T20:46:59Z",
"OccurEndTime": "2026-09-26T20:46:59Z",
"StartTime": "2026-09-26T20:46:59Z",
"EndTime": "2026-09-26T20:46:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"048535a8-5db6-4af2-8c67-1a5d847b186b",
"768c41bc-03fb-458c-952f-c9637d2dd260"
],
"Companies": [
"94f3db71-add5-44be-9988-7ac260a81a25",
"d82ae944-458d-47b7-ab54-59ea658d68bd"
],
"Groups": [
"e00b5430-8511-4b6e-ac2b-cb64532c55f9",
"701eef87-3054-4b67-9266-c0291d6492c8"
],
"Opportunities": [
"f109089b-01d8-452c-be63-32b4071ff9ad",
"fa560ebf-006a-4629-b52c-cdc88076d65e"
]
}
},
{
"Id": "59e8fbb5-5d14-4086-981b-deb3b45df495",
"SeriesId": "0874f203-caa2-417c-836e-013e962a3711",
"AccessorID": "a5911e50-2c28-4be2-87cf-dc2c86fdddb9",
"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": "41d8f6a6-c63a-419b-a504-b8373a968049",
"ScheduledByID": "ea8bbddc-bc74-4005-9858-0f8d44a396cd",
"DeletedDates": [
"2026-09-26T20:46:59Z",
"2026-09-26T20:46:59Z"
],
"ClearedDates": [
"2026-09-26T20:46:59Z",
"2026-09-26T20:46:59Z"
],
"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-26T20:46:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-26T20:46:59Z",
"CreateDate": "2026-09-26T20:46:59Z",
"OccurTime": "2026-09-26T20:46:59Z",
"OccurEndTime": "2026-09-26T20:46:59Z",
"StartTime": "2026-09-26T20:46:59Z",
"EndTime": "2026-09-26T20:46:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"048535a8-5db6-4af2-8c67-1a5d847b186b",
"768c41bc-03fb-458c-952f-c9637d2dd260"
],
"Companies": [
"94f3db71-add5-44be-9988-7ac260a81a25",
"d82ae944-458d-47b7-ab54-59ea658d68bd"
],
"Groups": [
"e00b5430-8511-4b6e-ac2b-cb64532c55f9",
"701eef87-3054-4b67-9266-c0291d6492c8"
],
"Opportunities": [
"f109089b-01d8-452c-be63-32b4071ff9ad",
"fa560ebf-006a-4629-b52c-cdc88076d65e"
]
}
}
]