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": "58dab1e1-3c6e-4914-9a3e-96fb1f8aac51",
"SeriesId": "c07e1dd0-a7c1-4f63-b6da-054705a3405e",
"AccessorID": "fe6fa64c-2395-46bb-9309-7d621973de34",
"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": "6ad7983f-950e-4914-9a95-cb43a69bde1f",
"ScheduledByID": "01e2361a-13c9-43fa-8b23-bd66bda04399",
"DeletedDates": [
"2026-11-13T02:00:35Z",
"2026-11-13T02:00:35Z"
],
"ClearedDates": [
"2026-11-13T02:00:35Z",
"2026-11-13T02:00:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-13T02:00:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-13T02:00:35Z",
"CreateDate": "2026-11-13T02:00:35Z",
"OccurTime": "2026-11-13T02:00:35Z",
"OccurEndTime": "2026-11-13T02:00:35Z",
"StartTime": "2026-11-13T02:00:35Z",
"EndTime": "2026-11-13T02:00:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"42585428-9eb0-4a71-af93-01eb72212e33",
"0e7974f1-6fd4-49dd-ac0c-af9ee79c7a3b"
],
"Companies": [
"1810a75a-d905-4f4e-8dc2-75916a8182d3",
"304c5a95-e327-4341-adf8-5fdb190f27d5"
],
"Groups": [
"01243fa0-25e4-4429-8438-9af2f6ab670d",
"aa1d1825-a9b8-4a79-a9ec-e0787f74e443"
],
"Opportunities": [
"80697435-fdaa-4ecc-a32f-6c487374ed44",
"cbe5a855-19a9-4d3d-a542-b10f58f0e284"
]
}
},
{
"Id": "58dab1e1-3c6e-4914-9a3e-96fb1f8aac51",
"SeriesId": "c07e1dd0-a7c1-4f63-b6da-054705a3405e",
"AccessorID": "fe6fa64c-2395-46bb-9309-7d621973de34",
"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": "6ad7983f-950e-4914-9a95-cb43a69bde1f",
"ScheduledByID": "01e2361a-13c9-43fa-8b23-bd66bda04399",
"DeletedDates": [
"2026-11-13T02:00:35Z",
"2026-11-13T02:00:35Z"
],
"ClearedDates": [
"2026-11-13T02:00:35Z",
"2026-11-13T02:00:35Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-13T02:00:35Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-13T02:00:35Z",
"CreateDate": "2026-11-13T02:00:35Z",
"OccurTime": "2026-11-13T02:00:35Z",
"OccurEndTime": "2026-11-13T02:00:35Z",
"StartTime": "2026-11-13T02:00:35Z",
"EndTime": "2026-11-13T02:00:35Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"42585428-9eb0-4a71-af93-01eb72212e33",
"0e7974f1-6fd4-49dd-ac0c-af9ee79c7a3b"
],
"Companies": [
"1810a75a-d905-4f4e-8dc2-75916a8182d3",
"304c5a95-e327-4341-adf8-5fdb190f27d5"
],
"Groups": [
"01243fa0-25e4-4429-8438-9af2f6ab670d",
"aa1d1825-a9b8-4a79-a9ec-e0787f74e443"
],
"Opportunities": [
"80697435-fdaa-4ecc-a32f-6c487374ed44",
"cbe5a855-19a9-4d3d-a542-b10f58f0e284"
]
}
}
]