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": "df64249b-65f8-43a7-9746-ebfb4fe6a5f6",
"SeriesId": "8cd4eba1-1c1b-4a2e-9bbe-0749d07ff11b",
"AccessorID": "237624db-d4ab-46b2-896a-6985b2913add",
"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": "54e9c0cf-950f-43a9-997e-05bbe43abb85",
"ScheduledByID": "edb54da7-4da7-41a6-a6ef-e62e08871aa7",
"DeletedDates": [
"2026-08-15T05:58:00Z",
"2026-08-15T05:58:00Z"
],
"ClearedDates": [
"2026-08-15T05:58:00Z",
"2026-08-15T05:58:00Z"
],
"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-15T05:58:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-15T05:58:00Z",
"CreateDate": "2026-08-15T05:58:00Z",
"OccurTime": "2026-08-15T05:58:00Z",
"OccurEndTime": "2026-08-15T05:58:00Z",
"StartTime": "2026-08-15T05:58:00Z",
"EndTime": "2026-08-15T05:58:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4c070e40-f30e-47c2-a70a-ff358d907d2b",
"4ef35301-0953-4458-bc54-601704b4cb57"
],
"Companies": [
"f0114bdd-7518-4741-afa8-d5c7b282e0cb",
"ebd41d37-a01d-46c0-be44-4f0a5294849b"
],
"Groups": [
"9f40edfb-6714-4a58-9de2-f8541be1cd40",
"ea44823b-1103-42ec-97b6-193e73d5f5d9"
],
"Opportunities": [
"c5e0a10b-238b-43e4-98dc-3f5b2e77a04c",
"4f8ef589-2a63-481b-a64f-a3a4c99339c7"
]
}
},
{
"Id": "df64249b-65f8-43a7-9746-ebfb4fe6a5f6",
"SeriesId": "8cd4eba1-1c1b-4a2e-9bbe-0749d07ff11b",
"AccessorID": "237624db-d4ab-46b2-896a-6985b2913add",
"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": "54e9c0cf-950f-43a9-997e-05bbe43abb85",
"ScheduledByID": "edb54da7-4da7-41a6-a6ef-e62e08871aa7",
"DeletedDates": [
"2026-08-15T05:58:00Z",
"2026-08-15T05:58:00Z"
],
"ClearedDates": [
"2026-08-15T05:58:00Z",
"2026-08-15T05:58:00Z"
],
"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-15T05:58:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-15T05:58:00Z",
"CreateDate": "2026-08-15T05:58:00Z",
"OccurTime": "2026-08-15T05:58:00Z",
"OccurEndTime": "2026-08-15T05:58:00Z",
"StartTime": "2026-08-15T05:58:00Z",
"EndTime": "2026-08-15T05:58:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4c070e40-f30e-47c2-a70a-ff358d907d2b",
"4ef35301-0953-4458-bc54-601704b4cb57"
],
"Companies": [
"f0114bdd-7518-4741-afa8-d5c7b282e0cb",
"ebd41d37-a01d-46c0-be44-4f0a5294849b"
],
"Groups": [
"9f40edfb-6714-4a58-9de2-f8541be1cd40",
"ea44823b-1103-42ec-97b6-193e73d5f5d9"
],
"Opportunities": [
"c5e0a10b-238b-43e4-98dc-3f5b2e77a04c",
"4f8ef589-2a63-481b-a64f-a3a4c99339c7"
]
}
}
]