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": "a97a6dc8-863e-4cea-ac51-31121fd6c913",
"SeriesId": "ec4c387e-5035-4362-96dd-563fab2ef10d",
"AccessorID": "384d59d2-e35a-4662-b5da-b0968cbc6b43",
"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": "c178cca4-550a-47ed-b884-33c9f4177cce",
"ScheduledByID": "6bcb8098-5723-4b9e-873d-5044ffce04c2",
"DeletedDates": [
"2026-06-12T00:58:38Z",
"2026-06-12T00:58:38Z"
],
"ClearedDates": [
"2026-06-12T00:58:38Z",
"2026-06-12T00:58:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-12T00:58:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-12T00:58:38Z",
"CreateDate": "2026-06-12T00:58:38Z",
"OccurTime": "2026-06-12T00:58:38Z",
"OccurEndTime": "2026-06-12T00:58:38Z",
"StartTime": "2026-06-12T00:58:38Z",
"EndTime": "2026-06-12T00:58:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3cd717a1-83d7-4db1-acf6-21e219c6f0f7",
"d3337446-38c3-4178-8588-5d9313f85b67"
],
"Companies": [
"9b346a4f-1a70-4f83-b96c-8696fbd7e671",
"210c1980-f746-43d8-8c88-b596fbb8b7da"
],
"Groups": [
"35104b06-305e-43a2-bdc6-a09fbc5a5d55",
"8fab1e1d-5a95-4640-887e-73cf3a7d7447"
],
"Opportunities": [
"0a8f4535-1635-40b2-b463-8cdc27fe6113",
"2aed8c49-7246-44f4-ad34-1e45bc799db1"
]
}
},
{
"Id": "a97a6dc8-863e-4cea-ac51-31121fd6c913",
"SeriesId": "ec4c387e-5035-4362-96dd-563fab2ef10d",
"AccessorID": "384d59d2-e35a-4662-b5da-b0968cbc6b43",
"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": "c178cca4-550a-47ed-b884-33c9f4177cce",
"ScheduledByID": "6bcb8098-5723-4b9e-873d-5044ffce04c2",
"DeletedDates": [
"2026-06-12T00:58:38Z",
"2026-06-12T00:58:38Z"
],
"ClearedDates": [
"2026-06-12T00:58:38Z",
"2026-06-12T00:58:38Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-12T00:58:38Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-12T00:58:38Z",
"CreateDate": "2026-06-12T00:58:38Z",
"OccurTime": "2026-06-12T00:58:38Z",
"OccurEndTime": "2026-06-12T00:58:38Z",
"StartTime": "2026-06-12T00:58:38Z",
"EndTime": "2026-06-12T00:58:38Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3cd717a1-83d7-4db1-acf6-21e219c6f0f7",
"d3337446-38c3-4178-8588-5d9313f85b67"
],
"Companies": [
"9b346a4f-1a70-4f83-b96c-8696fbd7e671",
"210c1980-f746-43d8-8c88-b596fbb8b7da"
],
"Groups": [
"35104b06-305e-43a2-bdc6-a09fbc5a5d55",
"8fab1e1d-5a95-4640-887e-73cf3a7d7447"
],
"Opportunities": [
"0a8f4535-1635-40b2-b463-8cdc27fe6113",
"2aed8c49-7246-44f4-ad34-1e45bc799db1"
]
}
}
]