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": "4abd7771-3e81-4d79-8d1c-b2e9c6c44f1f",
"SeriesId": "4d95eee0-8ce1-4da6-87ef-43998e3ac62e",
"AccessorID": "50db192c-55e8-47f7-be7d-74cad4fe0e68",
"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": "d456873e-d053-429f-9038-a5406162e7ca",
"ScheduledByID": "1ae05b3a-582e-43fa-b62b-c9650bfd9f70",
"DeletedDates": [
"2025-11-05T10:09:44Z",
"2025-11-05T10:09:44Z"
],
"ClearedDates": [
"2025-11-05T10:09:44Z",
"2025-11-05T10:09:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-05T10:09:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-05T10:09:44Z",
"CreateDate": "2025-11-05T10:09:44Z",
"OccurTime": "2025-11-05T10:09:44Z",
"OccurEndTime": "2025-11-05T10:09:44Z",
"StartTime": "2025-11-05T10:09:44Z",
"EndTime": "2025-11-05T10:09:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b05586e6-18bf-4771-b82e-677282bd155d",
"6850a9a7-88c9-42f9-b4aa-c4f1b7316016"
],
"Companies": [
"210bb66b-0375-4f23-b2e6-3b66473de7e0",
"cca8619d-5981-483a-8ae6-9b823c6b8989"
],
"Groups": [
"8e68db71-2f40-4c3a-8596-c844277e18dd",
"e17fcba2-9dbd-492c-8dcb-c540cae8ed50"
],
"Opportunities": [
"34e48bd5-a2ea-41a9-b14b-288e659d0de5",
"4ad4b702-d333-4675-95e0-84dde47bc3a4"
]
}
},
{
"Id": "4abd7771-3e81-4d79-8d1c-b2e9c6c44f1f",
"SeriesId": "4d95eee0-8ce1-4da6-87ef-43998e3ac62e",
"AccessorID": "50db192c-55e8-47f7-be7d-74cad4fe0e68",
"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": "d456873e-d053-429f-9038-a5406162e7ca",
"ScheduledByID": "1ae05b3a-582e-43fa-b62b-c9650bfd9f70",
"DeletedDates": [
"2025-11-05T10:09:44Z",
"2025-11-05T10:09:44Z"
],
"ClearedDates": [
"2025-11-05T10:09:44Z",
"2025-11-05T10:09:44Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2025-11-05T10:09:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2025-11-05T10:09:44Z",
"CreateDate": "2025-11-05T10:09:44Z",
"OccurTime": "2025-11-05T10:09:44Z",
"OccurEndTime": "2025-11-05T10:09:44Z",
"StartTime": "2025-11-05T10:09:44Z",
"EndTime": "2025-11-05T10:09:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"b05586e6-18bf-4771-b82e-677282bd155d",
"6850a9a7-88c9-42f9-b4aa-c4f1b7316016"
],
"Companies": [
"210bb66b-0375-4f23-b2e6-3b66473de7e0",
"cca8619d-5981-483a-8ae6-9b823c6b8989"
],
"Groups": [
"8e68db71-2f40-4c3a-8596-c844277e18dd",
"e17fcba2-9dbd-492c-8dcb-c540cae8ed50"
],
"Opportunities": [
"34e48bd5-a2ea-41a9-b14b-288e659d0de5",
"4ad4b702-d333-4675-95e0-84dde47bc3a4"
]
}
}
]