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": "1fe2c590-59b7-4d6c-92c8-093afa85f853",
"SeriesId": "7ba01ea2-4279-47b1-81e3-a7fcce3e5e71",
"AccessorID": "75ca5ac8-4ab4-4f39-a6b7-4dddd2dad704",
"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": "4856411f-e29f-499b-a92b-28aa468e7285",
"ScheduledByID": "81867ca3-39c3-4b90-841f-cd1cf5de0e7d",
"DeletedDates": [
"2026-07-03T00:30:03Z",
"2026-07-03T00:30:03Z"
],
"ClearedDates": [
"2026-07-03T00:30:03Z",
"2026-07-03T00:30:03Z"
],
"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-03T00:30:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-03T00:30:03Z",
"CreateDate": "2026-07-03T00:30:03Z",
"OccurTime": "2026-07-03T00:30:03Z",
"OccurEndTime": "2026-07-03T00:30:03Z",
"StartTime": "2026-07-03T00:30:03Z",
"EndTime": "2026-07-03T00:30:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d23222b6-b0e3-410d-ba16-18c4d0935ef8",
"605b1f52-ea85-434b-9eb3-6c49ddb8ff52"
],
"Companies": [
"b29188b5-69f2-492a-b832-2b83af770810",
"037f73c4-f0c1-4613-ab47-1bf6892521d0"
],
"Groups": [
"17172b28-eda2-4909-aaee-35ccbb2bd4d5",
"b7db8d4b-44ce-4971-a98d-e52ba8da652c"
],
"Opportunities": [
"ffc218b4-424f-4141-9f18-7ab9d4a2a35f",
"d45565f0-bbdd-404e-b51d-1b80cf092424"
]
}
},
{
"Id": "1fe2c590-59b7-4d6c-92c8-093afa85f853",
"SeriesId": "7ba01ea2-4279-47b1-81e3-a7fcce3e5e71",
"AccessorID": "75ca5ac8-4ab4-4f39-a6b7-4dddd2dad704",
"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": "4856411f-e29f-499b-a92b-28aa468e7285",
"ScheduledByID": "81867ca3-39c3-4b90-841f-cd1cf5de0e7d",
"DeletedDates": [
"2026-07-03T00:30:03Z",
"2026-07-03T00:30:03Z"
],
"ClearedDates": [
"2026-07-03T00:30:03Z",
"2026-07-03T00:30:03Z"
],
"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-03T00:30:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-03T00:30:03Z",
"CreateDate": "2026-07-03T00:30:03Z",
"OccurTime": "2026-07-03T00:30:03Z",
"OccurEndTime": "2026-07-03T00:30:03Z",
"StartTime": "2026-07-03T00:30:03Z",
"EndTime": "2026-07-03T00:30:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d23222b6-b0e3-410d-ba16-18c4d0935ef8",
"605b1f52-ea85-434b-9eb3-6c49ddb8ff52"
],
"Companies": [
"b29188b5-69f2-492a-b832-2b83af770810",
"037f73c4-f0c1-4613-ab47-1bf6892521d0"
],
"Groups": [
"17172b28-eda2-4909-aaee-35ccbb2bd4d5",
"b7db8d4b-44ce-4971-a98d-e52ba8da652c"
],
"Opportunities": [
"ffc218b4-424f-4141-9f18-7ab9d4a2a35f",
"d45565f0-bbdd-404e-b51d-1b80cf092424"
]
}
}
]