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": "2113a11a-48bc-410e-9329-9c4cbed58c54",
"SeriesId": "54012bcc-b4f5-4078-8526-2889f7d1b96c",
"AccessorID": "d2ccdfee-8c37-4e21-b438-9fcbeaf2f885",
"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": "e42c7da7-bcf2-4511-b1d3-015b583776e4",
"ScheduledByID": "109d12fc-bcc2-4728-bd37-315e14a85906",
"DeletedDates": [
"2026-09-27T09:02:48Z",
"2026-09-27T09:02:48Z"
],
"ClearedDates": [
"2026-09-27T09:02:48Z",
"2026-09-27T09:02:48Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-27T09:02:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-27T09:02:48Z",
"CreateDate": "2026-09-27T09:02:48Z",
"OccurTime": "2026-09-27T09:02:48Z",
"OccurEndTime": "2026-09-27T09:02:48Z",
"StartTime": "2026-09-27T09:02:48Z",
"EndTime": "2026-09-27T09:02:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f658f5de-d5e3-44a5-8cd2-435260207d22",
"dc5fc3e2-bb88-42f5-accb-bcbafbe6d556"
],
"Companies": [
"e79b2bec-d134-455b-8332-09975e223afe",
"06e0237d-f264-4395-9dc1-fca9f835a400"
],
"Groups": [
"93020b37-49ab-4b4f-aa3b-4be912a90bb5",
"4e046d03-e62c-48e9-83af-5c9f28e77b65"
],
"Opportunities": [
"53bd7a8d-11b2-4471-84fd-1ed1d62ef1b2",
"71240b6a-b37a-4666-895d-ba2575f53ec9"
]
}
},
{
"Id": "2113a11a-48bc-410e-9329-9c4cbed58c54",
"SeriesId": "54012bcc-b4f5-4078-8526-2889f7d1b96c",
"AccessorID": "d2ccdfee-8c37-4e21-b438-9fcbeaf2f885",
"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": "e42c7da7-bcf2-4511-b1d3-015b583776e4",
"ScheduledByID": "109d12fc-bcc2-4728-bd37-315e14a85906",
"DeletedDates": [
"2026-09-27T09:02:48Z",
"2026-09-27T09:02:48Z"
],
"ClearedDates": [
"2026-09-27T09:02:48Z",
"2026-09-27T09:02:48Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-27T09:02:48Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-27T09:02:48Z",
"CreateDate": "2026-09-27T09:02:48Z",
"OccurTime": "2026-09-27T09:02:48Z",
"OccurEndTime": "2026-09-27T09:02:48Z",
"StartTime": "2026-09-27T09:02:48Z",
"EndTime": "2026-09-27T09:02:48Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f658f5de-d5e3-44a5-8cd2-435260207d22",
"dc5fc3e2-bb88-42f5-accb-bcbafbe6d556"
],
"Companies": [
"e79b2bec-d134-455b-8332-09975e223afe",
"06e0237d-f264-4395-9dc1-fca9f835a400"
],
"Groups": [
"93020b37-49ab-4b4f-aa3b-4be912a90bb5",
"4e046d03-e62c-48e9-83af-5c9f28e77b65"
],
"Opportunities": [
"53bd7a8d-11b2-4471-84fd-1ed1d62ef1b2",
"71240b6a-b37a-4666-895d-ba2575f53ec9"
]
}
}
]