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": "f06e5a15-0070-4aa0-9ff7-6b33174798c3",
"SeriesId": "a04cdb33-2059-45c2-82fe-d3f2277167ba",
"AccessorID": "d1516a1b-72b7-4653-97cf-3293694616fc",
"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": "659f50a0-0418-406c-9c4a-5ea60415c555",
"ScheduledByID": "5e67c06b-9306-41be-8947-95825102fa25",
"DeletedDates": [
"2026-09-15T13:04:32Z",
"2026-09-15T13:04:32Z"
],
"ClearedDates": [
"2026-09-15T13:04:32Z",
"2026-09-15T13:04:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-15T13:04:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-15T13:04:32Z",
"CreateDate": "2026-09-15T13:04:32Z",
"OccurTime": "2026-09-15T13:04:32Z",
"OccurEndTime": "2026-09-15T13:04:32Z",
"StartTime": "2026-09-15T13:04:32Z",
"EndTime": "2026-09-15T13:04:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b4ffd5fc-061c-44ef-b6f5-241336da377e",
"d2ceef05-3a92-4151-8027-c8d7646ca5fc"
],
"Companies": [
"15c4319d-902e-4053-9262-65cd8144a7b0",
"fd9d5c52-3754-4eb8-be1e-6973e4364501"
],
"Groups": [
"d2db7aed-6070-436b-a784-bf63a60f7ffa",
"aff70a49-8228-4373-894c-ae17348991f4"
],
"Opportunities": [
"f064d540-8fe1-4cd8-9bec-9cd22c403d95",
"3e07ac57-4945-4f7f-b58b-12f60fcae4d6"
]
}
},
{
"Id": "f06e5a15-0070-4aa0-9ff7-6b33174798c3",
"SeriesId": "a04cdb33-2059-45c2-82fe-d3f2277167ba",
"AccessorID": "d1516a1b-72b7-4653-97cf-3293694616fc",
"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": "659f50a0-0418-406c-9c4a-5ea60415c555",
"ScheduledByID": "5e67c06b-9306-41be-8947-95825102fa25",
"DeletedDates": [
"2026-09-15T13:04:32Z",
"2026-09-15T13:04:32Z"
],
"ClearedDates": [
"2026-09-15T13:04:32Z",
"2026-09-15T13:04:32Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-15T13:04:32Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-15T13:04:32Z",
"CreateDate": "2026-09-15T13:04:32Z",
"OccurTime": "2026-09-15T13:04:32Z",
"OccurEndTime": "2026-09-15T13:04:32Z",
"StartTime": "2026-09-15T13:04:32Z",
"EndTime": "2026-09-15T13:04:32Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b4ffd5fc-061c-44ef-b6f5-241336da377e",
"d2ceef05-3a92-4151-8027-c8d7646ca5fc"
],
"Companies": [
"15c4319d-902e-4053-9262-65cd8144a7b0",
"fd9d5c52-3754-4eb8-be1e-6973e4364501"
],
"Groups": [
"d2db7aed-6070-436b-a784-bf63a60f7ffa",
"aff70a49-8228-4373-894c-ae17348991f4"
],
"Opportunities": [
"f064d540-8fe1-4cd8-9bec-9cd22c403d95",
"3e07ac57-4945-4f7f-b58b-12f60fcae4d6"
]
}
}
]