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": "4026495a-7347-4fd7-aac6-84919ff17521",
"SeriesId": "c64b7073-a914-4deb-9ebe-3e86a5a2349d",
"AccessorID": "cecb5e75-5e7e-437d-b1e4-c234e46383b3",
"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": "d7e41840-1f31-4284-ab29-f176516dcd1c",
"ScheduledByID": "cb6bc8f8-baee-41f8-ba6b-33f11a422805",
"DeletedDates": [
"2026-11-04T21:24:07Z",
"2026-11-04T21:24:07Z"
],
"ClearedDates": [
"2026-11-04T21:24:07Z",
"2026-11-04T21:24:07Z"
],
"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-04T21:24:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-04T21:24:07Z",
"CreateDate": "2026-11-04T21:24:07Z",
"OccurTime": "2026-11-04T21:24:07Z",
"OccurEndTime": "2026-11-04T21:24:07Z",
"StartTime": "2026-11-04T21:24:07Z",
"EndTime": "2026-11-04T21:24:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"66edf225-e3e2-4a8e-a9f8-5bfecb17380d",
"b7f0a6ee-81da-4b77-99ad-48c1d12d87d7"
],
"Companies": [
"e0fca55e-a599-4cbb-93fc-f70117cb1d77",
"cd5b4ace-7a4a-4178-a192-0ecaebc00e02"
],
"Groups": [
"5a804448-3e47-4599-9be8-6adec1a41454",
"0d589dd9-7e98-4f47-9552-65bb3f3822cb"
],
"Opportunities": [
"a9f2b238-02c4-44f5-a759-b643bcb559b7",
"83901242-8f34-4a33-ba4e-8b9997f9230d"
]
}
},
{
"Id": "4026495a-7347-4fd7-aac6-84919ff17521",
"SeriesId": "c64b7073-a914-4deb-9ebe-3e86a5a2349d",
"AccessorID": "cecb5e75-5e7e-437d-b1e4-c234e46383b3",
"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": "d7e41840-1f31-4284-ab29-f176516dcd1c",
"ScheduledByID": "cb6bc8f8-baee-41f8-ba6b-33f11a422805",
"DeletedDates": [
"2026-11-04T21:24:07Z",
"2026-11-04T21:24:07Z"
],
"ClearedDates": [
"2026-11-04T21:24:07Z",
"2026-11-04T21:24:07Z"
],
"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-04T21:24:07Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-04T21:24:07Z",
"CreateDate": "2026-11-04T21:24:07Z",
"OccurTime": "2026-11-04T21:24:07Z",
"OccurEndTime": "2026-11-04T21:24:07Z",
"StartTime": "2026-11-04T21:24:07Z",
"EndTime": "2026-11-04T21:24:07Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"66edf225-e3e2-4a8e-a9f8-5bfecb17380d",
"b7f0a6ee-81da-4b77-99ad-48c1d12d87d7"
],
"Companies": [
"e0fca55e-a599-4cbb-93fc-f70117cb1d77",
"cd5b4ace-7a4a-4178-a192-0ecaebc00e02"
],
"Groups": [
"5a804448-3e47-4599-9be8-6adec1a41454",
"0d589dd9-7e98-4f47-9552-65bb3f3822cb"
],
"Opportunities": [
"a9f2b238-02c4-44f5-a759-b643bcb559b7",
"83901242-8f34-4a33-ba4e-8b9997f9230d"
]
}
}
]