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": "736c47a9-a101-46f7-bb71-d7b57da854d7",
"SeriesId": "91c65578-68b0-4d6a-89bd-aac637465c42",
"AccessorID": "1d00712e-bc5f-428c-a3d3-13e1fd20ecbb",
"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": "3f73e734-58bf-4b52-8f62-56634120f97c",
"ScheduledByID": "fe8cf034-2b22-4fd4-84f5-603094e39a3d",
"DeletedDates": [
"2026-11-10T14:12:09Z",
"2026-11-10T14:12:09Z"
],
"ClearedDates": [
"2026-11-10T14:12:09Z",
"2026-11-10T14:12:09Z"
],
"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-10T14:12:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-10T14:12:09Z",
"CreateDate": "2026-11-10T14:12:09Z",
"OccurTime": "2026-11-10T14:12:09Z",
"OccurEndTime": "2026-11-10T14:12:09Z",
"StartTime": "2026-11-10T14:12:09Z",
"EndTime": "2026-11-10T14:12:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0507055f-feed-480c-b082-f09a1dbc7651",
"c2001b0f-408f-4e32-9a28-440ca838d829"
],
"Companies": [
"24dc57ce-3fc2-4bcc-86aa-caae00ed3130",
"a423ccc6-5d1c-4fb8-9fbc-250892b24430"
],
"Groups": [
"cf0a96a9-1038-44fb-9d92-664f71757a3b",
"cadd4871-9f85-449d-ad90-bf000e16a5d7"
],
"Opportunities": [
"28a53454-3662-4496-8f93-20bcc4df0d5c",
"155aa5d5-e714-41ef-a8f4-add19b0a4631"
]
}
},
{
"Id": "736c47a9-a101-46f7-bb71-d7b57da854d7",
"SeriesId": "91c65578-68b0-4d6a-89bd-aac637465c42",
"AccessorID": "1d00712e-bc5f-428c-a3d3-13e1fd20ecbb",
"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": "3f73e734-58bf-4b52-8f62-56634120f97c",
"ScheduledByID": "fe8cf034-2b22-4fd4-84f5-603094e39a3d",
"DeletedDates": [
"2026-11-10T14:12:09Z",
"2026-11-10T14:12:09Z"
],
"ClearedDates": [
"2026-11-10T14:12:09Z",
"2026-11-10T14:12:09Z"
],
"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-10T14:12:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-10T14:12:09Z",
"CreateDate": "2026-11-10T14:12:09Z",
"OccurTime": "2026-11-10T14:12:09Z",
"OccurEndTime": "2026-11-10T14:12:09Z",
"StartTime": "2026-11-10T14:12:09Z",
"EndTime": "2026-11-10T14:12:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0507055f-feed-480c-b082-f09a1dbc7651",
"c2001b0f-408f-4e32-9a28-440ca838d829"
],
"Companies": [
"24dc57ce-3fc2-4bcc-86aa-caae00ed3130",
"a423ccc6-5d1c-4fb8-9fbc-250892b24430"
],
"Groups": [
"cf0a96a9-1038-44fb-9d92-664f71757a3b",
"cadd4871-9f85-449d-ad90-bf000e16a5d7"
],
"Opportunities": [
"28a53454-3662-4496-8f93-20bcc4df0d5c",
"155aa5d5-e714-41ef-a8f4-add19b0a4631"
]
}
}
]