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": "bf690cd5-ff22-4fef-9b88-560dd59cc039",
"SeriesId": "0acee2c8-78fe-4bcb-806a-7d01a99355c2",
"AccessorID": "b636f76f-d0e1-4f29-b561-6553fecb64f4",
"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": "0d5df69a-bdb1-4597-9d0a-2c2747bdfdf4",
"ScheduledByID": "4b09ad13-23cf-4c18-b102-54fbf8c4d6df",
"DeletedDates": [
"2026-09-16T17:42:24Z",
"2026-09-16T17:42:24Z"
],
"ClearedDates": [
"2026-09-16T17:42:24Z",
"2026-09-16T17:42:24Z"
],
"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-16T17:42:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-16T17:42:24Z",
"CreateDate": "2026-09-16T17:42:24Z",
"OccurTime": "2026-09-16T17:42:24Z",
"OccurEndTime": "2026-09-16T17:42:24Z",
"StartTime": "2026-09-16T17:42:24Z",
"EndTime": "2026-09-16T17:42:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f1f7f0e7-1a24-49c2-9afd-0183ce782515",
"e695fdcb-d864-4f4e-b7bf-376cc43289d4"
],
"Companies": [
"9eb34ad7-5799-48e8-880d-c403ae1c9bdb",
"d008a785-6faa-42bd-a637-4292dbc5d1bb"
],
"Groups": [
"c088b572-349b-4b28-9981-7f0b585f2c10",
"82306d82-e965-4a82-b3a4-69a997895196"
],
"Opportunities": [
"064d7c86-8ebd-434b-8959-c7894ca4d953",
"936c5161-b977-4a4d-a1c1-537cd950d3f9"
]
}
},
{
"Id": "bf690cd5-ff22-4fef-9b88-560dd59cc039",
"SeriesId": "0acee2c8-78fe-4bcb-806a-7d01a99355c2",
"AccessorID": "b636f76f-d0e1-4f29-b561-6553fecb64f4",
"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": "0d5df69a-bdb1-4597-9d0a-2c2747bdfdf4",
"ScheduledByID": "4b09ad13-23cf-4c18-b102-54fbf8c4d6df",
"DeletedDates": [
"2026-09-16T17:42:24Z",
"2026-09-16T17:42:24Z"
],
"ClearedDates": [
"2026-09-16T17:42:24Z",
"2026-09-16T17:42:24Z"
],
"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-16T17:42:24Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-16T17:42:24Z",
"CreateDate": "2026-09-16T17:42:24Z",
"OccurTime": "2026-09-16T17:42:24Z",
"OccurEndTime": "2026-09-16T17:42:24Z",
"StartTime": "2026-09-16T17:42:24Z",
"EndTime": "2026-09-16T17:42:24Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f1f7f0e7-1a24-49c2-9afd-0183ce782515",
"e695fdcb-d864-4f4e-b7bf-376cc43289d4"
],
"Companies": [
"9eb34ad7-5799-48e8-880d-c403ae1c9bdb",
"d008a785-6faa-42bd-a637-4292dbc5d1bb"
],
"Groups": [
"c088b572-349b-4b28-9981-7f0b585f2c10",
"82306d82-e965-4a82-b3a4-69a997895196"
],
"Opportunities": [
"064d7c86-8ebd-434b-8959-c7894ca4d953",
"936c5161-b977-4a4d-a1c1-537cd950d3f9"
]
}
}
]