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": "68e11967-6b0e-47ac-9983-29e627fccafa",
"SeriesId": "aa221b11-d2e8-4680-ae31-c6cb1b523820",
"AccessorID": "28b3a6d0-3292-4527-ba9a-8fcf5fe5b0f6",
"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": "4d6da14c-047a-4eaf-b77c-f40be012c079",
"ScheduledByID": "35ecfb47-49cd-49c4-8d46-64ca62c9f2e2",
"DeletedDates": [
"2026-08-24T15:07:39Z",
"2026-08-24T15:07:39Z"
],
"ClearedDates": [
"2026-08-24T15:07:39Z",
"2026-08-24T15:07:39Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-24T15:07:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-24T15:07:39Z",
"CreateDate": "2026-08-24T15:07:39Z",
"OccurTime": "2026-08-24T15:07:39Z",
"OccurEndTime": "2026-08-24T15:07:39Z",
"StartTime": "2026-08-24T15:07:39Z",
"EndTime": "2026-08-24T15:07:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ce0a8b1d-2861-4973-9766-36fd3e126036",
"6f690577-6c64-44c6-aae5-c5eb77489930"
],
"Companies": [
"d37525c0-99dc-49cd-a93b-a015e2b566e9",
"3147e8af-27ff-4c7c-9c52-989e030b7d36"
],
"Groups": [
"4aec5663-9798-45e5-9e86-0a1922af8508",
"670da544-84dd-45b9-8e1b-62fba35161e2"
],
"Opportunities": [
"3fb0c770-c048-412c-8e92-5948a4217f63",
"eee8e275-ee1c-42da-9763-673425ae54fd"
]
}
},
{
"Id": "68e11967-6b0e-47ac-9983-29e627fccafa",
"SeriesId": "aa221b11-d2e8-4680-ae31-c6cb1b523820",
"AccessorID": "28b3a6d0-3292-4527-ba9a-8fcf5fe5b0f6",
"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": "4d6da14c-047a-4eaf-b77c-f40be012c079",
"ScheduledByID": "35ecfb47-49cd-49c4-8d46-64ca62c9f2e2",
"DeletedDates": [
"2026-08-24T15:07:39Z",
"2026-08-24T15:07:39Z"
],
"ClearedDates": [
"2026-08-24T15:07:39Z",
"2026-08-24T15:07:39Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-24T15:07:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-24T15:07:39Z",
"CreateDate": "2026-08-24T15:07:39Z",
"OccurTime": "2026-08-24T15:07:39Z",
"OccurEndTime": "2026-08-24T15:07:39Z",
"StartTime": "2026-08-24T15:07:39Z",
"EndTime": "2026-08-24T15:07:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ce0a8b1d-2861-4973-9766-36fd3e126036",
"6f690577-6c64-44c6-aae5-c5eb77489930"
],
"Companies": [
"d37525c0-99dc-49cd-a93b-a015e2b566e9",
"3147e8af-27ff-4c7c-9c52-989e030b7d36"
],
"Groups": [
"4aec5663-9798-45e5-9e86-0a1922af8508",
"670da544-84dd-45b9-8e1b-62fba35161e2"
],
"Opportunities": [
"3fb0c770-c048-412c-8e92-5948a4217f63",
"eee8e275-ee1c-42da-9763-673425ae54fd"
]
}
}
]