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": "85e5488a-eaea-4ac9-bdf9-f5276e06ce17",
"SeriesId": "bf25e3ac-5d4c-4db6-b1a9-5f4932b1625c",
"AccessorID": "9cbd789a-a24b-4f19-9bc7-6ad1829da6d1",
"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": "4c4bee00-95dc-4161-a40c-5f2a7497d6f6",
"ScheduledByID": "7029851c-6278-48f3-9e64-ed1b5ff249fb",
"DeletedDates": [
"2026-08-02T22:57:05Z",
"2026-08-02T22:57:05Z"
],
"ClearedDates": [
"2026-08-02T22:57:05Z",
"2026-08-02T22:57:05Z"
],
"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-02T22:57:05Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-02T22:57:05Z",
"CreateDate": "2026-08-02T22:57:05Z",
"OccurTime": "2026-08-02T22:57:05Z",
"OccurEndTime": "2026-08-02T22:57:05Z",
"StartTime": "2026-08-02T22:57:05Z",
"EndTime": "2026-08-02T22:57:05Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f291194f-46aa-40b3-b644-a301a01b70e8",
"b549cac5-5fc7-444c-a6e3-aadc7c7572c5"
],
"Companies": [
"4cb80d7b-e887-4fb7-ac74-484fecca1af1",
"f90304ee-b7cb-414a-bba4-bc3e16f58a70"
],
"Groups": [
"c075ba61-098a-4a5b-8e07-0bbfc98ef4c0",
"7f3d8eb4-d912-4135-bac1-fcea9fb51d94"
],
"Opportunities": [
"c1250a0e-248f-4365-9885-6949ea9f615e",
"fa3ccb3b-6641-4876-a082-2341c0c68e1b"
]
}
},
{
"Id": "85e5488a-eaea-4ac9-bdf9-f5276e06ce17",
"SeriesId": "bf25e3ac-5d4c-4db6-b1a9-5f4932b1625c",
"AccessorID": "9cbd789a-a24b-4f19-9bc7-6ad1829da6d1",
"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": "4c4bee00-95dc-4161-a40c-5f2a7497d6f6",
"ScheduledByID": "7029851c-6278-48f3-9e64-ed1b5ff249fb",
"DeletedDates": [
"2026-08-02T22:57:05Z",
"2026-08-02T22:57:05Z"
],
"ClearedDates": [
"2026-08-02T22:57:05Z",
"2026-08-02T22:57:05Z"
],
"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-02T22:57:05Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-02T22:57:05Z",
"CreateDate": "2026-08-02T22:57:05Z",
"OccurTime": "2026-08-02T22:57:05Z",
"OccurEndTime": "2026-08-02T22:57:05Z",
"StartTime": "2026-08-02T22:57:05Z",
"EndTime": "2026-08-02T22:57:05Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f291194f-46aa-40b3-b644-a301a01b70e8",
"b549cac5-5fc7-444c-a6e3-aadc7c7572c5"
],
"Companies": [
"4cb80d7b-e887-4fb7-ac74-484fecca1af1",
"f90304ee-b7cb-414a-bba4-bc3e16f58a70"
],
"Groups": [
"c075ba61-098a-4a5b-8e07-0bbfc98ef4c0",
"7f3d8eb4-d912-4135-bac1-fcea9fb51d94"
],
"Opportunities": [
"c1250a0e-248f-4365-9885-6949ea9f615e",
"fa3ccb3b-6641-4876-a082-2341c0c68e1b"
]
}
}
]