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": "6cf6e33a-01a8-4ee6-ac2e-815c69834d6a",
"SeriesId": "394bb866-08c3-475d-ba27-27839614f48a",
"AccessorID": "685e3790-4099-4646-817d-a1487f97a54b",
"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": "6a2cbc50-a8f0-4566-97af-bff35e208b1e",
"ScheduledByID": "d91abec9-99b2-4b8f-8bd4-ce6b4012d7a8",
"DeletedDates": [
"2026-11-08T12:56:45Z",
"2026-11-08T12:56:45Z"
],
"ClearedDates": [
"2026-11-08T12:56:45Z",
"2026-11-08T12:56:45Z"
],
"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-08T12:56:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-08T12:56:45Z",
"CreateDate": "2026-11-08T12:56:45Z",
"OccurTime": "2026-11-08T12:56:45Z",
"OccurEndTime": "2026-11-08T12:56:45Z",
"StartTime": "2026-11-08T12:56:45Z",
"EndTime": "2026-11-08T12:56:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3a32c8a0-0578-4500-b9ca-aac974682186",
"cbc1a160-8b22-44ac-b571-aa8b2775c8d1"
],
"Companies": [
"3dbc90b9-52f9-4708-bcc3-48d21ad62c86",
"7cd33f97-0f6b-47c4-9b61-5e1f8c123e82"
],
"Groups": [
"c03f86bb-48f1-40f3-a6af-3cac5d6e3b4d",
"0444315a-21dd-493a-8100-44c9c6372faf"
],
"Opportunities": [
"8bd734cf-e54a-4dbc-9d84-bc033faf1623",
"fe5b52ad-9360-43c3-aef8-632d8e7c976a"
]
}
},
{
"Id": "6cf6e33a-01a8-4ee6-ac2e-815c69834d6a",
"SeriesId": "394bb866-08c3-475d-ba27-27839614f48a",
"AccessorID": "685e3790-4099-4646-817d-a1487f97a54b",
"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": "6a2cbc50-a8f0-4566-97af-bff35e208b1e",
"ScheduledByID": "d91abec9-99b2-4b8f-8bd4-ce6b4012d7a8",
"DeletedDates": [
"2026-11-08T12:56:45Z",
"2026-11-08T12:56:45Z"
],
"ClearedDates": [
"2026-11-08T12:56:45Z",
"2026-11-08T12:56:45Z"
],
"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-08T12:56:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-08T12:56:45Z",
"CreateDate": "2026-11-08T12:56:45Z",
"OccurTime": "2026-11-08T12:56:45Z",
"OccurEndTime": "2026-11-08T12:56:45Z",
"StartTime": "2026-11-08T12:56:45Z",
"EndTime": "2026-11-08T12:56:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3a32c8a0-0578-4500-b9ca-aac974682186",
"cbc1a160-8b22-44ac-b571-aa8b2775c8d1"
],
"Companies": [
"3dbc90b9-52f9-4708-bcc3-48d21ad62c86",
"7cd33f97-0f6b-47c4-9b61-5e1f8c123e82"
],
"Groups": [
"c03f86bb-48f1-40f3-a6af-3cac5d6e3b4d",
"0444315a-21dd-493a-8100-44c9c6372faf"
],
"Opportunities": [
"8bd734cf-e54a-4dbc-9d84-bc033faf1623",
"fe5b52ad-9360-43c3-aef8-632d8e7c976a"
]
}
}
]