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": "22c20ca0-8e3c-4d1f-8957-be4eec6f9682",
"SeriesId": "9946c9e0-6079-4ab6-bf35-4d12d7f3ce02",
"AccessorID": "357bc2d6-3ba9-4dd0-99af-b5cb00588915",
"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": "f7c058cc-4192-4f68-9878-51eba48b1498",
"ScheduledByID": "c2bb9144-3f1c-44a5-b365-a2791cf7c670",
"DeletedDates": [
"2026-06-21T08:51:40Z",
"2026-06-21T08:51:40Z"
],
"ClearedDates": [
"2026-06-21T08:51:40Z",
"2026-06-21T08:51:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-21T08:51:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-21T08:51:40Z",
"CreateDate": "2026-06-21T08:51:40Z",
"OccurTime": "2026-06-21T08:51:40Z",
"OccurEndTime": "2026-06-21T08:51:40Z",
"StartTime": "2026-06-21T08:51:40Z",
"EndTime": "2026-06-21T08:51:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"31c5e3c8-fab2-4994-90b0-b962cbb76e6a",
"1b287d99-bec7-4201-9179-256d74a4ef83"
],
"Companies": [
"eb21dc0e-39a6-437e-a81b-7adb19b4194f",
"207eb05d-aebd-4a5c-9fd8-20e8d8e94ae7"
],
"Groups": [
"77f7cf64-e3b8-43dc-8278-50e4d75c8704",
"05dd0070-98c7-4eb7-8998-2fbf4e7f18f0"
],
"Opportunities": [
"42d5a782-ac60-4b05-81ea-ef5884b1be51",
"9e7b218c-bea8-4c8b-a637-30c9a80a3c21"
]
}
},
{
"Id": "22c20ca0-8e3c-4d1f-8957-be4eec6f9682",
"SeriesId": "9946c9e0-6079-4ab6-bf35-4d12d7f3ce02",
"AccessorID": "357bc2d6-3ba9-4dd0-99af-b5cb00588915",
"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": "f7c058cc-4192-4f68-9878-51eba48b1498",
"ScheduledByID": "c2bb9144-3f1c-44a5-b365-a2791cf7c670",
"DeletedDates": [
"2026-06-21T08:51:40Z",
"2026-06-21T08:51:40Z"
],
"ClearedDates": [
"2026-06-21T08:51:40Z",
"2026-06-21T08:51:40Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-21T08:51:40Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-21T08:51:40Z",
"CreateDate": "2026-06-21T08:51:40Z",
"OccurTime": "2026-06-21T08:51:40Z",
"OccurEndTime": "2026-06-21T08:51:40Z",
"StartTime": "2026-06-21T08:51:40Z",
"EndTime": "2026-06-21T08:51:40Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"31c5e3c8-fab2-4994-90b0-b962cbb76e6a",
"1b287d99-bec7-4201-9179-256d74a4ef83"
],
"Companies": [
"eb21dc0e-39a6-437e-a81b-7adb19b4194f",
"207eb05d-aebd-4a5c-9fd8-20e8d8e94ae7"
],
"Groups": [
"77f7cf64-e3b8-43dc-8278-50e4d75c8704",
"05dd0070-98c7-4eb7-8998-2fbf4e7f18f0"
],
"Opportunities": [
"42d5a782-ac60-4b05-81ea-ef5884b1be51",
"9e7b218c-bea8-4c8b-a637-30c9a80a3c21"
]
}
}
]