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": "5f97f10d-17ee-4b23-a9fa-160f722da109",
"SeriesId": "559fea01-d14a-456a-a294-1490139564d4",
"AccessorID": "45d4cd94-b049-4d40-97b0-c3dee26fca8c",
"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": "75f30973-a9bc-422a-92e7-720d3c6e5561",
"ScheduledByID": "2fbe24d2-89de-4bb2-842a-4cf5bff8ae33",
"DeletedDates": [
"2026-09-02T22:51:33Z",
"2026-09-02T22:51:33Z"
],
"ClearedDates": [
"2026-09-02T22:51:33Z",
"2026-09-02T22:51:33Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-02T22:51:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-02T22:51:33Z",
"CreateDate": "2026-09-02T22:51:33Z",
"OccurTime": "2026-09-02T22:51:33Z",
"OccurEndTime": "2026-09-02T22:51:33Z",
"StartTime": "2026-09-02T22:51:33Z",
"EndTime": "2026-09-02T22:51:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9731643c-d313-453c-b951-40b515e329c8",
"12ced66d-76af-4c1a-bd64-c4999b2a6ee6"
],
"Companies": [
"470301cc-19d0-4985-9b97-5a411a48e73a",
"293fd1d6-7af6-4a97-b559-eaf0cf519774"
],
"Groups": [
"8f2ff68f-5e68-48a8-86c1-17e58563168d",
"0e959479-54ed-40f9-baf1-b147c80a8740"
],
"Opportunities": [
"2cde13de-bea3-4458-adac-6ea648dd0069",
"f84a2661-c7df-471c-91a9-c432eb26570c"
]
}
},
{
"Id": "5f97f10d-17ee-4b23-a9fa-160f722da109",
"SeriesId": "559fea01-d14a-456a-a294-1490139564d4",
"AccessorID": "45d4cd94-b049-4d40-97b0-c3dee26fca8c",
"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": "75f30973-a9bc-422a-92e7-720d3c6e5561",
"ScheduledByID": "2fbe24d2-89de-4bb2-842a-4cf5bff8ae33",
"DeletedDates": [
"2026-09-02T22:51:33Z",
"2026-09-02T22:51:33Z"
],
"ClearedDates": [
"2026-09-02T22:51:33Z",
"2026-09-02T22:51:33Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-02T22:51:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-02T22:51:33Z",
"CreateDate": "2026-09-02T22:51:33Z",
"OccurTime": "2026-09-02T22:51:33Z",
"OccurEndTime": "2026-09-02T22:51:33Z",
"StartTime": "2026-09-02T22:51:33Z",
"EndTime": "2026-09-02T22:51:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9731643c-d313-453c-b951-40b515e329c8",
"12ced66d-76af-4c1a-bd64-c4999b2a6ee6"
],
"Companies": [
"470301cc-19d0-4985-9b97-5a411a48e73a",
"293fd1d6-7af6-4a97-b559-eaf0cf519774"
],
"Groups": [
"8f2ff68f-5e68-48a8-86c1-17e58563168d",
"0e959479-54ed-40f9-baf1-b147c80a8740"
],
"Opportunities": [
"2cde13de-bea3-4458-adac-6ea648dd0069",
"f84a2661-c7df-471c-91a9-c432eb26570c"
]
}
}
]