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": "b3296396-f11c-45ed-a199-f768f41bc48f",
"SeriesId": "0484aef8-2eae-4008-aa53-a5d6b421d843",
"AccessorID": "9960a512-f82e-4886-acbe-198b4b003a2c",
"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": "fece4b3b-e777-4cf8-8493-404a2196179a",
"ScheduledByID": "5a30c767-f7b5-40c0-ba0e-af3c2861ccc3",
"DeletedDates": [
"2026-09-12T08:23:59Z",
"2026-09-12T08:23:59Z"
],
"ClearedDates": [
"2026-09-12T08:23:59Z",
"2026-09-12T08:23: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-12T08:23:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-12T08:23:59Z",
"CreateDate": "2026-09-12T08:23:59Z",
"OccurTime": "2026-09-12T08:23:59Z",
"OccurEndTime": "2026-09-12T08:23:59Z",
"StartTime": "2026-09-12T08:23:59Z",
"EndTime": "2026-09-12T08:23:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"fc546ee3-c622-4656-9e5a-408f07e86a05",
"8d3db1cb-71bd-42c2-9bfe-fc1b30213ab3"
],
"Companies": [
"c130e9d3-3f88-4825-908f-cefa95b64233",
"6f40a321-5957-4ad3-a70f-f049f051635f"
],
"Groups": [
"cf72e5f2-ad4a-464b-a738-4e859041de67",
"bc985ba2-1428-4aef-9f44-0d1b9de90d2f"
],
"Opportunities": [
"d4632ab4-c635-4077-a369-de176cf9f210",
"b94ad2b3-d9cf-4cac-9c3a-d1b712eff385"
]
}
},
{
"Id": "b3296396-f11c-45ed-a199-f768f41bc48f",
"SeriesId": "0484aef8-2eae-4008-aa53-a5d6b421d843",
"AccessorID": "9960a512-f82e-4886-acbe-198b4b003a2c",
"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": "fece4b3b-e777-4cf8-8493-404a2196179a",
"ScheduledByID": "5a30c767-f7b5-40c0-ba0e-af3c2861ccc3",
"DeletedDates": [
"2026-09-12T08:23:59Z",
"2026-09-12T08:23:59Z"
],
"ClearedDates": [
"2026-09-12T08:23:59Z",
"2026-09-12T08:23: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-12T08:23:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-12T08:23:59Z",
"CreateDate": "2026-09-12T08:23:59Z",
"OccurTime": "2026-09-12T08:23:59Z",
"OccurEndTime": "2026-09-12T08:23:59Z",
"StartTime": "2026-09-12T08:23:59Z",
"EndTime": "2026-09-12T08:23:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"fc546ee3-c622-4656-9e5a-408f07e86a05",
"8d3db1cb-71bd-42c2-9bfe-fc1b30213ab3"
],
"Companies": [
"c130e9d3-3f88-4825-908f-cefa95b64233",
"6f40a321-5957-4ad3-a70f-f049f051635f"
],
"Groups": [
"cf72e5f2-ad4a-464b-a738-4e859041de67",
"bc985ba2-1428-4aef-9f44-0d1b9de90d2f"
],
"Opportunities": [
"d4632ab4-c635-4077-a369-de176cf9f210",
"b94ad2b3-d9cf-4cac-9c3a-d1b712eff385"
]
}
}
]