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": "c7e4f55c-b80b-4557-be34-cdc41d7afaf0",
"SeriesId": "b4e78a64-066d-4945-9cb5-41af17a23efc",
"AccessorID": "d05c269a-ad34-4c37-b312-7a969dc52c4f",
"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": "439d6262-c86d-4d56-bf3b-4dbe56e086ad",
"ScheduledByID": "379ec198-2b3c-4a2b-8eaa-5a2cb55b80c3",
"DeletedDates": [
"2026-01-14T05:20:42Z",
"2026-01-14T05:20:42Z"
],
"ClearedDates": [
"2026-01-14T05:20:42Z",
"2026-01-14T05:20:42Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-14T05:20:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-14T05:20:42Z",
"CreateDate": "2026-01-14T05:20:42Z",
"OccurTime": "2026-01-14T05:20:42Z",
"OccurEndTime": "2026-01-14T05:20:42Z",
"StartTime": "2026-01-14T05:20:42Z",
"EndTime": "2026-01-14T05:20:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f5a98ce-9b76-451e-a7c3-0f7dec267897",
"2c1babee-69be-4da1-8f5d-3637905e38ae"
],
"Companies": [
"088641bb-8014-4eb9-92cf-dc7bc5e66395",
"8434aea3-b550-4b64-80f1-8b277f7f3e03"
],
"Groups": [
"637420dd-4194-4ec8-97d4-439490565838",
"3d183528-5fb6-49f5-aab9-8ff873c98503"
],
"Opportunities": [
"25939709-6cbb-4f4c-886c-ac5a57853bfa",
"02e816e0-1a9d-4c73-a213-a33d75434244"
]
}
},
{
"Id": "c7e4f55c-b80b-4557-be34-cdc41d7afaf0",
"SeriesId": "b4e78a64-066d-4945-9cb5-41af17a23efc",
"AccessorID": "d05c269a-ad34-4c37-b312-7a969dc52c4f",
"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": "439d6262-c86d-4d56-bf3b-4dbe56e086ad",
"ScheduledByID": "379ec198-2b3c-4a2b-8eaa-5a2cb55b80c3",
"DeletedDates": [
"2026-01-14T05:20:42Z",
"2026-01-14T05:20:42Z"
],
"ClearedDates": [
"2026-01-14T05:20:42Z",
"2026-01-14T05:20:42Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-01-14T05:20:42Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-01-14T05:20:42Z",
"CreateDate": "2026-01-14T05:20:42Z",
"OccurTime": "2026-01-14T05:20:42Z",
"OccurEndTime": "2026-01-14T05:20:42Z",
"StartTime": "2026-01-14T05:20:42Z",
"EndTime": "2026-01-14T05:20:42Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3f5a98ce-9b76-451e-a7c3-0f7dec267897",
"2c1babee-69be-4da1-8f5d-3637905e38ae"
],
"Companies": [
"088641bb-8014-4eb9-92cf-dc7bc5e66395",
"8434aea3-b550-4b64-80f1-8b277f7f3e03"
],
"Groups": [
"637420dd-4194-4ec8-97d4-439490565838",
"3d183528-5fb6-49f5-aab9-8ff873c98503"
],
"Opportunities": [
"25939709-6cbb-4f4c-886c-ac5a57853bfa",
"02e816e0-1a9d-4c73-a213-a33d75434244"
]
}
}
]