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": "5d33edf3-ddcb-4bdf-96e8-aab7f0ddb9dd",
"SeriesId": "5a717f9d-beca-4f49-9582-184451c989ef",
"AccessorID": "1be13c72-9326-465a-a03a-eac09526a1c5",
"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": "01998d9f-081d-4ec9-8be0-136676d7bcbe",
"ScheduledByID": "4a1c7770-31ba-4418-ada8-ce98638998a7",
"DeletedDates": [
"2026-07-30T22:23:49Z",
"2026-07-30T22:23:49Z"
],
"ClearedDates": [
"2026-07-30T22:23:49Z",
"2026-07-30T22:23:49Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-30T22:23:50Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-30T22:23:50Z",
"CreateDate": "2026-07-30T22:23:50Z",
"OccurTime": "2026-07-30T22:23:50Z",
"OccurEndTime": "2026-07-30T22:23:50Z",
"StartTime": "2026-07-30T22:23:50Z",
"EndTime": "2026-07-30T22:23:50Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"93a0a71c-c1ef-4e91-8616-b00b353817a9",
"0f3c62fb-ad37-4ded-b3be-972cc0f2f995"
],
"Companies": [
"e339534e-e333-419e-a64b-381c7ddecd4d",
"34d75bbb-27d7-4dbf-a734-bd80c993de8b"
],
"Groups": [
"7d0c279e-0d9d-46e0-89df-61f5145f45e2",
"fd064fcb-56db-4ac4-aed0-a4af9f1cdaf2"
],
"Opportunities": [
"ce117c7f-04a3-4431-b0f4-b6dc20b3e25a",
"52a8f0a0-8f08-47c0-88c3-bc324c06cc8a"
]
}
},
{
"Id": "5d33edf3-ddcb-4bdf-96e8-aab7f0ddb9dd",
"SeriesId": "5a717f9d-beca-4f49-9582-184451c989ef",
"AccessorID": "1be13c72-9326-465a-a03a-eac09526a1c5",
"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": "01998d9f-081d-4ec9-8be0-136676d7bcbe",
"ScheduledByID": "4a1c7770-31ba-4418-ada8-ce98638998a7",
"DeletedDates": [
"2026-07-30T22:23:49Z",
"2026-07-30T22:23:49Z"
],
"ClearedDates": [
"2026-07-30T22:23:49Z",
"2026-07-30T22:23:49Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-30T22:23:50Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-30T22:23:50Z",
"CreateDate": "2026-07-30T22:23:50Z",
"OccurTime": "2026-07-30T22:23:50Z",
"OccurEndTime": "2026-07-30T22:23:50Z",
"StartTime": "2026-07-30T22:23:50Z",
"EndTime": "2026-07-30T22:23:50Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"93a0a71c-c1ef-4e91-8616-b00b353817a9",
"0f3c62fb-ad37-4ded-b3be-972cc0f2f995"
],
"Companies": [
"e339534e-e333-419e-a64b-381c7ddecd4d",
"34d75bbb-27d7-4dbf-a734-bd80c993de8b"
],
"Groups": [
"7d0c279e-0d9d-46e0-89df-61f5145f45e2",
"fd064fcb-56db-4ac4-aed0-a4af9f1cdaf2"
],
"Opportunities": [
"ce117c7f-04a3-4431-b0f4-b6dc20b3e25a",
"52a8f0a0-8f08-47c0-88c3-bc324c06cc8a"
]
}
}
]