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": "00b848ab-1fc4-4972-a56c-1b6ee3e950fa",
"SeriesId": "74137458-4f70-4fe5-a4a4-9d3cc6acf8f4",
"AccessorID": "5bc0b73e-b98a-4c2e-a778-69117ace2bf9",
"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": "4400d842-c567-41dd-95c3-bbcf2715c2fa",
"ScheduledByID": "60600235-1e79-4d10-afa6-692ee20d9cde",
"DeletedDates": [
"2026-07-22T11:20:06Z",
"2026-07-22T11:20:06Z"
],
"ClearedDates": [
"2026-07-22T11:20:06Z",
"2026-07-22T11:20: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-22T11:20:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-22T11:20:06Z",
"CreateDate": "2026-07-22T11:20:06Z",
"OccurTime": "2026-07-22T11:20:06Z",
"OccurEndTime": "2026-07-22T11:20:06Z",
"StartTime": "2026-07-22T11:20:06Z",
"EndTime": "2026-07-22T11:20:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f6e64901-aac2-4a6f-b292-2ccb536db0af",
"bad27059-1443-4d70-890a-f4852ac949fd"
],
"Companies": [
"69959fa1-4c7c-4c5d-b047-26ccadbe8665",
"148b6713-6a4d-4d0e-b6a6-377a24ce68dc"
],
"Groups": [
"053c6538-2587-41fa-ad69-7ab882b87ced",
"dd029501-475a-4d14-9ca7-a55ce5622d02"
],
"Opportunities": [
"464c636b-1d24-44a1-9355-ce529707ed05",
"42819b7d-2c9b-4d7a-8c67-f0be1aa730e4"
]
}
},
{
"Id": "00b848ab-1fc4-4972-a56c-1b6ee3e950fa",
"SeriesId": "74137458-4f70-4fe5-a4a4-9d3cc6acf8f4",
"AccessorID": "5bc0b73e-b98a-4c2e-a778-69117ace2bf9",
"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": "4400d842-c567-41dd-95c3-bbcf2715c2fa",
"ScheduledByID": "60600235-1e79-4d10-afa6-692ee20d9cde",
"DeletedDates": [
"2026-07-22T11:20:06Z",
"2026-07-22T11:20:06Z"
],
"ClearedDates": [
"2026-07-22T11:20:06Z",
"2026-07-22T11:20: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-22T11:20:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-22T11:20:06Z",
"CreateDate": "2026-07-22T11:20:06Z",
"OccurTime": "2026-07-22T11:20:06Z",
"OccurEndTime": "2026-07-22T11:20:06Z",
"StartTime": "2026-07-22T11:20:06Z",
"EndTime": "2026-07-22T11:20:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f6e64901-aac2-4a6f-b292-2ccb536db0af",
"bad27059-1443-4d70-890a-f4852ac949fd"
],
"Companies": [
"69959fa1-4c7c-4c5d-b047-26ccadbe8665",
"148b6713-6a4d-4d0e-b6a6-377a24ce68dc"
],
"Groups": [
"053c6538-2587-41fa-ad69-7ab882b87ced",
"dd029501-475a-4d14-9ca7-a55ce5622d02"
],
"Opportunities": [
"464c636b-1d24-44a1-9355-ce529707ed05",
"42819b7d-2c9b-4d7a-8c67-f0be1aa730e4"
]
}
}
]