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": "64a7e7b7-63a9-4fe8-8a1f-c4ec30bb29cc",
"SeriesId": "6eca205e-18ab-46d5-a3d6-a2d8bbd711d8",
"AccessorID": "32f47e22-40b6-4e23-b55b-9d1f6de6da83",
"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": "aee66f33-fe57-43ea-b0b4-251f0eab8b48",
"ScheduledByID": "9f6a1013-1453-4421-8ea8-125cdce96865",
"DeletedDates": [
"2026-09-20T13:47:10Z",
"2026-09-20T13:47:10Z"
],
"ClearedDates": [
"2026-09-20T13:47:10Z",
"2026-09-20T13:47:10Z"
],
"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-20T13:47:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-20T13:47:10Z",
"CreateDate": "2026-09-20T13:47:10Z",
"OccurTime": "2026-09-20T13:47:10Z",
"OccurEndTime": "2026-09-20T13:47:10Z",
"StartTime": "2026-09-20T13:47:10Z",
"EndTime": "2026-09-20T13:47:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"89b8af05-606a-4a90-bd06-3b1fe2162d09",
"a6f7a378-d644-4856-99c6-ac9511f07037"
],
"Companies": [
"2ec8ca7c-50c1-4e17-8f7e-ea33cb2593a6",
"17f4fec2-19a9-4f70-bf62-272dd5377e87"
],
"Groups": [
"083f3906-5cb2-45ff-a399-ce7fbe0e656d",
"401450b3-1c58-4a1e-adca-809d73a2c077"
],
"Opportunities": [
"6349837b-c72b-44e8-a6a0-53a078536b74",
"87e68f10-7b6c-424d-9b55-61c19b39e4d2"
]
}
},
{
"Id": "64a7e7b7-63a9-4fe8-8a1f-c4ec30bb29cc",
"SeriesId": "6eca205e-18ab-46d5-a3d6-a2d8bbd711d8",
"AccessorID": "32f47e22-40b6-4e23-b55b-9d1f6de6da83",
"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": "aee66f33-fe57-43ea-b0b4-251f0eab8b48",
"ScheduledByID": "9f6a1013-1453-4421-8ea8-125cdce96865",
"DeletedDates": [
"2026-09-20T13:47:10Z",
"2026-09-20T13:47:10Z"
],
"ClearedDates": [
"2026-09-20T13:47:10Z",
"2026-09-20T13:47:10Z"
],
"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-20T13:47:10Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-20T13:47:10Z",
"CreateDate": "2026-09-20T13:47:10Z",
"OccurTime": "2026-09-20T13:47:10Z",
"OccurEndTime": "2026-09-20T13:47:10Z",
"StartTime": "2026-09-20T13:47:10Z",
"EndTime": "2026-09-20T13:47:10Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"89b8af05-606a-4a90-bd06-3b1fe2162d09",
"a6f7a378-d644-4856-99c6-ac9511f07037"
],
"Companies": [
"2ec8ca7c-50c1-4e17-8f7e-ea33cb2593a6",
"17f4fec2-19a9-4f70-bf62-272dd5377e87"
],
"Groups": [
"083f3906-5cb2-45ff-a399-ce7fbe0e656d",
"401450b3-1c58-4a1e-adca-809d73a2c077"
],
"Opportunities": [
"6349837b-c72b-44e8-a6a0-53a078536b74",
"87e68f10-7b6c-424d-9b55-61c19b39e4d2"
]
}
}
]