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": "13503e66-036d-4694-a541-6d890b10f1eb",
"SeriesId": "929e72d5-b28e-48d0-8aba-6c1133d0a3a1",
"AccessorID": "45ad2bed-dd94-4725-a40c-e75cdbcdc669",
"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": "8d34d6d5-6101-4de9-b943-a22723d35860",
"ScheduledByID": "0ef47005-ce38-4128-8eab-5478241434e4",
"DeletedDates": [
"2026-07-23T12:51:06Z",
"2026-07-23T12:51:06Z"
],
"ClearedDates": [
"2026-07-23T12:51:06Z",
"2026-07-23T12:51:06Z"
],
"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-23T12:51:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-23T12:51:06Z",
"CreateDate": "2026-07-23T12:51:06Z",
"OccurTime": "2026-07-23T12:51:06Z",
"OccurEndTime": "2026-07-23T12:51:06Z",
"StartTime": "2026-07-23T12:51:06Z",
"EndTime": "2026-07-23T12:51:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bfffe79e-c41f-4766-99dc-c06aeb0c6163",
"abf8d28f-0dd9-455e-8fbf-03c8531dd9d7"
],
"Companies": [
"fa7de49b-9f91-4f2d-a2b5-0e97ba2a7a0a",
"47dcb7e3-c11b-4369-afa6-5f01cfc5c4a4"
],
"Groups": [
"c375f1fa-a3dd-4894-bc39-0236fbbd58da",
"f3b1faf8-157b-4cb8-9fac-667c37bae1ad"
],
"Opportunities": [
"b4b3fbda-73b4-47bc-84fc-74f54cb2f409",
"f986aee7-f80f-4053-a2b0-6eeb573d8a1f"
]
}
},
{
"Id": "13503e66-036d-4694-a541-6d890b10f1eb",
"SeriesId": "929e72d5-b28e-48d0-8aba-6c1133d0a3a1",
"AccessorID": "45ad2bed-dd94-4725-a40c-e75cdbcdc669",
"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": "8d34d6d5-6101-4de9-b943-a22723d35860",
"ScheduledByID": "0ef47005-ce38-4128-8eab-5478241434e4",
"DeletedDates": [
"2026-07-23T12:51:06Z",
"2026-07-23T12:51:06Z"
],
"ClearedDates": [
"2026-07-23T12:51:06Z",
"2026-07-23T12:51:06Z"
],
"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-23T12:51:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-23T12:51:06Z",
"CreateDate": "2026-07-23T12:51:06Z",
"OccurTime": "2026-07-23T12:51:06Z",
"OccurEndTime": "2026-07-23T12:51:06Z",
"StartTime": "2026-07-23T12:51:06Z",
"EndTime": "2026-07-23T12:51:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bfffe79e-c41f-4766-99dc-c06aeb0c6163",
"abf8d28f-0dd9-455e-8fbf-03c8531dd9d7"
],
"Companies": [
"fa7de49b-9f91-4f2d-a2b5-0e97ba2a7a0a",
"47dcb7e3-c11b-4369-afa6-5f01cfc5c4a4"
],
"Groups": [
"c375f1fa-a3dd-4894-bc39-0236fbbd58da",
"f3b1faf8-157b-4cb8-9fac-667c37bae1ad"
],
"Opportunities": [
"b4b3fbda-73b4-47bc-84fc-74f54cb2f409",
"f986aee7-f80f-4053-a2b0-6eeb573d8a1f"
]
}
}
]