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": "7d7224fc-368e-4e8c-931d-20eee357f90c",
"SeriesId": "bc0718db-ab01-4e6b-9a00-58aafe93be6b",
"AccessorID": "22c0a720-8952-46fc-aa73-3ee4adcecdd7",
"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": "62ae3204-5cb3-44f4-885b-fc833c78faca",
"ScheduledByID": "fbc461e8-525d-4625-a435-c78e85819891",
"DeletedDates": [
"2026-11-22T21:59:08Z",
"2026-11-22T21:59:08Z"
],
"ClearedDates": [
"2026-11-22T21:59:08Z",
"2026-11-22T21:59:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-22T21:59:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-22T21:59:08Z",
"CreateDate": "2026-11-22T21:59:08Z",
"OccurTime": "2026-11-22T21:59:08Z",
"OccurEndTime": "2026-11-22T21:59:08Z",
"StartTime": "2026-11-22T21:59:08Z",
"EndTime": "2026-11-22T21:59:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ccca2641-244c-44c9-8dd9-f55bd8201663",
"d6701521-00cb-49a1-b87c-19249a9cc6a6"
],
"Companies": [
"ba383997-4f69-4757-9b65-ff95de4464ee",
"706f21df-a24e-416d-8906-33b1ff3ef048"
],
"Groups": [
"9adcf33e-cbfb-4d6e-af71-74f8c9f16ac1",
"4282807d-ea4d-434b-8d00-ec8f662d3672"
],
"Opportunities": [
"6d62bdb6-a540-4eba-8fff-96286076797f",
"8649de9b-8f00-420b-85c4-98e926b0153c"
]
}
},
{
"Id": "7d7224fc-368e-4e8c-931d-20eee357f90c",
"SeriesId": "bc0718db-ab01-4e6b-9a00-58aafe93be6b",
"AccessorID": "22c0a720-8952-46fc-aa73-3ee4adcecdd7",
"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": "62ae3204-5cb3-44f4-885b-fc833c78faca",
"ScheduledByID": "fbc461e8-525d-4625-a435-c78e85819891",
"DeletedDates": [
"2026-11-22T21:59:08Z",
"2026-11-22T21:59:08Z"
],
"ClearedDates": [
"2026-11-22T21:59:08Z",
"2026-11-22T21:59:08Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-22T21:59:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-22T21:59:08Z",
"CreateDate": "2026-11-22T21:59:08Z",
"OccurTime": "2026-11-22T21:59:08Z",
"OccurEndTime": "2026-11-22T21:59:08Z",
"StartTime": "2026-11-22T21:59:08Z",
"EndTime": "2026-11-22T21:59:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ccca2641-244c-44c9-8dd9-f55bd8201663",
"d6701521-00cb-49a1-b87c-19249a9cc6a6"
],
"Companies": [
"ba383997-4f69-4757-9b65-ff95de4464ee",
"706f21df-a24e-416d-8906-33b1ff3ef048"
],
"Groups": [
"9adcf33e-cbfb-4d6e-af71-74f8c9f16ac1",
"4282807d-ea4d-434b-8d00-ec8f662d3672"
],
"Opportunities": [
"6d62bdb6-a540-4eba-8fff-96286076797f",
"8649de9b-8f00-420b-85c4-98e926b0153c"
]
}
}
]