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": "4ee1b96a-79e7-4a5a-80e5-0809992d2409",
"SeriesId": "6d4adac2-603f-4723-bbc0-58cc20fa9d60",
"AccessorID": "45bbfef1-a8c0-41b9-9e24-e9536f963e27",
"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": "ec9a750e-9493-4844-a8bc-328f04b798b1",
"ScheduledByID": "141e0df8-a601-47c4-a9b1-d746c8b668b2",
"DeletedDates": [
"2026-07-09T22:55:49Z",
"2026-07-09T22:55:49Z"
],
"ClearedDates": [
"2026-07-09T22:55:49Z",
"2026-07-09T22:55:49Z"
],
"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-09T22:55:49Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-09T22:55:49Z",
"CreateDate": "2026-07-09T22:55:49Z",
"OccurTime": "2026-07-09T22:55:49Z",
"OccurEndTime": "2026-07-09T22:55:49Z",
"StartTime": "2026-07-09T22:55:49Z",
"EndTime": "2026-07-09T22:55:49Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4c56284f-0b02-40f5-b129-b1953448577d",
"1041f0bc-d015-433e-a464-8e8d8a383982"
],
"Companies": [
"97116f59-e48b-4e1d-bc9d-1942ce96d0b6",
"20e787b5-d651-4710-8d3c-18e21d2f55b7"
],
"Groups": [
"43a32a2a-b26b-48de-9d39-487fa3ae7d63",
"6346d5b8-91ea-4a23-bcff-b68c2a4bf492"
],
"Opportunities": [
"142a6d6d-41a3-45c9-83ea-5c5ffd04e4e2",
"ac1afe2a-6704-49cf-a930-dc25baf4af19"
]
}
},
{
"Id": "4ee1b96a-79e7-4a5a-80e5-0809992d2409",
"SeriesId": "6d4adac2-603f-4723-bbc0-58cc20fa9d60",
"AccessorID": "45bbfef1-a8c0-41b9-9e24-e9536f963e27",
"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": "ec9a750e-9493-4844-a8bc-328f04b798b1",
"ScheduledByID": "141e0df8-a601-47c4-a9b1-d746c8b668b2",
"DeletedDates": [
"2026-07-09T22:55:49Z",
"2026-07-09T22:55:49Z"
],
"ClearedDates": [
"2026-07-09T22:55:49Z",
"2026-07-09T22:55:49Z"
],
"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-09T22:55:49Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-09T22:55:49Z",
"CreateDate": "2026-07-09T22:55:49Z",
"OccurTime": "2026-07-09T22:55:49Z",
"OccurEndTime": "2026-07-09T22:55:49Z",
"StartTime": "2026-07-09T22:55:49Z",
"EndTime": "2026-07-09T22:55:49Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4c56284f-0b02-40f5-b129-b1953448577d",
"1041f0bc-d015-433e-a464-8e8d8a383982"
],
"Companies": [
"97116f59-e48b-4e1d-bc9d-1942ce96d0b6",
"20e787b5-d651-4710-8d3c-18e21d2f55b7"
],
"Groups": [
"43a32a2a-b26b-48de-9d39-487fa3ae7d63",
"6346d5b8-91ea-4a23-bcff-b68c2a4bf492"
],
"Opportunities": [
"142a6d6d-41a3-45c9-83ea-5c5ffd04e4e2",
"ac1afe2a-6704-49cf-a930-dc25baf4af19"
]
}
}
]