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": "f612a320-3836-4555-b200-30f23aa8c939",
"SeriesId": "e17270f9-33d1-4fea-94c2-277be92ba9f2",
"AccessorID": "16c75fae-84f9-4eb6-9668-0bbfed30d747",
"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": "b7ef59a7-ffa8-4de9-91ad-e8eefd7fe034",
"ScheduledByID": "07e7a1a6-bf28-46d6-ac9e-338518cd1bdb",
"DeletedDates": [
"2026-08-04T23:40:54Z",
"2026-08-04T23:40:54Z"
],
"ClearedDates": [
"2026-08-04T23:40:54Z",
"2026-08-04T23:40:54Z"
],
"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-04T23:40:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-04T23:40:54Z",
"CreateDate": "2026-08-04T23:40:54Z",
"OccurTime": "2026-08-04T23:40:54Z",
"OccurEndTime": "2026-08-04T23:40:54Z",
"StartTime": "2026-08-04T23:40:54Z",
"EndTime": "2026-08-04T23:40:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c50d3afc-7e44-4c4d-9116-82c9a0b449ff",
"8820aa41-0a59-49e9-a570-80a08dcbfb63"
],
"Companies": [
"e90937b6-5a04-4059-bb64-f066f295e728",
"1d5318c8-7a59-420c-ab1d-012e93134d16"
],
"Groups": [
"98fbaee3-19fc-4488-aba2-d18d040dd954",
"76a3371f-055c-4716-8480-f644b2b72642"
],
"Opportunities": [
"9e0ff6a0-59fc-4c5e-ba1d-d7678ef68f20",
"7f81ee58-0260-4d2f-ac3e-37a523fe012a"
]
}
},
{
"Id": "f612a320-3836-4555-b200-30f23aa8c939",
"SeriesId": "e17270f9-33d1-4fea-94c2-277be92ba9f2",
"AccessorID": "16c75fae-84f9-4eb6-9668-0bbfed30d747",
"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": "b7ef59a7-ffa8-4de9-91ad-e8eefd7fe034",
"ScheduledByID": "07e7a1a6-bf28-46d6-ac9e-338518cd1bdb",
"DeletedDates": [
"2026-08-04T23:40:54Z",
"2026-08-04T23:40:54Z"
],
"ClearedDates": [
"2026-08-04T23:40:54Z",
"2026-08-04T23:40:54Z"
],
"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-04T23:40:54Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-04T23:40:54Z",
"CreateDate": "2026-08-04T23:40:54Z",
"OccurTime": "2026-08-04T23:40:54Z",
"OccurEndTime": "2026-08-04T23:40:54Z",
"StartTime": "2026-08-04T23:40:54Z",
"EndTime": "2026-08-04T23:40:54Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"c50d3afc-7e44-4c4d-9116-82c9a0b449ff",
"8820aa41-0a59-49e9-a570-80a08dcbfb63"
],
"Companies": [
"e90937b6-5a04-4059-bb64-f066f295e728",
"1d5318c8-7a59-420c-ab1d-012e93134d16"
],
"Groups": [
"98fbaee3-19fc-4488-aba2-d18d040dd954",
"76a3371f-055c-4716-8480-f644b2b72642"
],
"Opportunities": [
"9e0ff6a0-59fc-4c5e-ba1d-d7678ef68f20",
"7f81ee58-0260-4d2f-ac3e-37a523fe012a"
]
}
}
]