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": "6915c40c-1de8-4854-8122-46381df55447",
"SeriesId": "f1ce1ea1-a330-4a04-9f1d-8ca1941001eb",
"AccessorID": "12ee3516-48fb-4109-b3e1-27be7041ca4e",
"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": "78f23f71-2f32-4d11-8cc4-1309703b585a",
"ScheduledByID": "be81b310-6349-4f7f-954e-384bf44cfa7b",
"DeletedDates": [
"2026-05-30T15:01:00Z",
"2026-05-30T15:01:00Z"
],
"ClearedDates": [
"2026-05-30T15:01:00Z",
"2026-05-30T15:01:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-30T15:01:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-30T15:01:00Z",
"CreateDate": "2026-05-30T15:01:00Z",
"OccurTime": "2026-05-30T15:01:00Z",
"OccurEndTime": "2026-05-30T15:01:00Z",
"StartTime": "2026-05-30T15:01:00Z",
"EndTime": "2026-05-30T15:01:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"effeeb57-cb29-4166-b5a0-bdd96e75bc76",
"77eccddd-eb2b-4ae5-b224-0b466b42819b"
],
"Companies": [
"3d2f3d44-5850-489d-b615-a920bffcbfe3",
"73d0b17b-ea8e-489a-b0e2-17734b0d5ff0"
],
"Groups": [
"a7f7c82d-763a-4f31-b656-e05761deb7fd",
"843a98c4-5a34-47b2-98e0-530bb5b27d68"
],
"Opportunities": [
"ba95deed-18f8-40ae-8b22-d61ffb9b454c",
"619aae6f-c48f-43e8-b273-bd7b297e8064"
]
}
},
{
"Id": "6915c40c-1de8-4854-8122-46381df55447",
"SeriesId": "f1ce1ea1-a330-4a04-9f1d-8ca1941001eb",
"AccessorID": "12ee3516-48fb-4109-b3e1-27be7041ca4e",
"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": "78f23f71-2f32-4d11-8cc4-1309703b585a",
"ScheduledByID": "be81b310-6349-4f7f-954e-384bf44cfa7b",
"DeletedDates": [
"2026-05-30T15:01:00Z",
"2026-05-30T15:01:00Z"
],
"ClearedDates": [
"2026-05-30T15:01:00Z",
"2026-05-30T15:01:00Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-30T15:01:00Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-30T15:01:00Z",
"CreateDate": "2026-05-30T15:01:00Z",
"OccurTime": "2026-05-30T15:01:00Z",
"OccurEndTime": "2026-05-30T15:01:00Z",
"StartTime": "2026-05-30T15:01:00Z",
"EndTime": "2026-05-30T15:01:00Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"effeeb57-cb29-4166-b5a0-bdd96e75bc76",
"77eccddd-eb2b-4ae5-b224-0b466b42819b"
],
"Companies": [
"3d2f3d44-5850-489d-b615-a920bffcbfe3",
"73d0b17b-ea8e-489a-b0e2-17734b0d5ff0"
],
"Groups": [
"a7f7c82d-763a-4f31-b656-e05761deb7fd",
"843a98c4-5a34-47b2-98e0-530bb5b27d68"
],
"Opportunities": [
"ba95deed-18f8-40ae-8b22-d61ffb9b454c",
"619aae6f-c48f-43e8-b273-bd7b297e8064"
]
}
}
]