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": "c8fc475c-1511-4f3e-aac5-2468cde4f4fa",
"SeriesId": "a5ff81e2-76b2-4b32-973d-d3ea606af5b5",
"AccessorID": "37fa104d-eb16-4a4a-b72b-33dafd5d50bd",
"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": "0c7a484b-91e1-41e3-8673-661cc9d80407",
"ScheduledByID": "5865adf7-08e2-48b5-a21d-44f1751da8d1",
"DeletedDates": [
"2026-10-19T18:08:13Z",
"2026-10-19T18:08:13Z"
],
"ClearedDates": [
"2026-10-19T18:08:13Z",
"2026-10-19T18:08:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-19T18:08:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-19T18:08:13Z",
"CreateDate": "2026-10-19T18:08:13Z",
"OccurTime": "2026-10-19T18:08:13Z",
"OccurEndTime": "2026-10-19T18:08:13Z",
"StartTime": "2026-10-19T18:08:13Z",
"EndTime": "2026-10-19T18:08:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ab2f618a-6f66-4d88-aa3e-866bc3ca0522",
"97f13066-8fc7-49e0-b1c4-7cfa1fc1cbe6"
],
"Companies": [
"49ee9f17-894f-4b98-b1a9-56e989dde93e",
"7057b8a7-44b9-4fed-970a-2269c041ed59"
],
"Groups": [
"92d6982d-ac7b-4b40-97f9-88e0491b1593",
"2dd69bae-c39b-4b04-8138-8d688f21025c"
],
"Opportunities": [
"3683fea9-2db5-49a0-8fda-d991cbdb81a0",
"f0445c21-a6b5-4ece-94d8-40af41ca8169"
]
}
},
{
"Id": "c8fc475c-1511-4f3e-aac5-2468cde4f4fa",
"SeriesId": "a5ff81e2-76b2-4b32-973d-d3ea606af5b5",
"AccessorID": "37fa104d-eb16-4a4a-b72b-33dafd5d50bd",
"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": "0c7a484b-91e1-41e3-8673-661cc9d80407",
"ScheduledByID": "5865adf7-08e2-48b5-a21d-44f1751da8d1",
"DeletedDates": [
"2026-10-19T18:08:13Z",
"2026-10-19T18:08:13Z"
],
"ClearedDates": [
"2026-10-19T18:08:13Z",
"2026-10-19T18:08:13Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-19T18:08:13Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-19T18:08:13Z",
"CreateDate": "2026-10-19T18:08:13Z",
"OccurTime": "2026-10-19T18:08:13Z",
"OccurEndTime": "2026-10-19T18:08:13Z",
"StartTime": "2026-10-19T18:08:13Z",
"EndTime": "2026-10-19T18:08:13Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ab2f618a-6f66-4d88-aa3e-866bc3ca0522",
"97f13066-8fc7-49e0-b1c4-7cfa1fc1cbe6"
],
"Companies": [
"49ee9f17-894f-4b98-b1a9-56e989dde93e",
"7057b8a7-44b9-4fed-970a-2269c041ed59"
],
"Groups": [
"92d6982d-ac7b-4b40-97f9-88e0491b1593",
"2dd69bae-c39b-4b04-8138-8d688f21025c"
],
"Opportunities": [
"3683fea9-2db5-49a0-8fda-d991cbdb81a0",
"f0445c21-a6b5-4ece-94d8-40af41ca8169"
]
}
}
]