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": "014977c2-9011-41eb-85a3-ca8880d55fb0",
"SeriesId": "5d6bdcfe-106e-4430-a4b9-4a9d90a37328",
"AccessorID": "8ddab3df-defe-43e4-830d-0e42751e4803",
"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": "62005805-9bdd-4904-89c9-c8b9d45d243e",
"ScheduledByID": "15b5f118-2636-4b97-a6c8-acd2f55f84d4",
"DeletedDates": [
"2026-08-21T12:01:14Z",
"2026-08-21T12:01:14Z"
],
"ClearedDates": [
"2026-08-21T12:01:14Z",
"2026-08-21T12:01:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-21T12:01:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-21T12:01:14Z",
"CreateDate": "2026-08-21T12:01:14Z",
"OccurTime": "2026-08-21T12:01:14Z",
"OccurEndTime": "2026-08-21T12:01:14Z",
"StartTime": "2026-08-21T12:01:14Z",
"EndTime": "2026-08-21T12:01:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efb13db6-0a23-4a4a-9952-ce976a436810",
"ccca7f44-6e36-433b-a67c-d619701270c9"
],
"Companies": [
"a4b9f3c6-8a46-4c3c-94cb-d30b809ed7b8",
"0966652b-dba1-4d14-8bca-524b871fd337"
],
"Groups": [
"72c8f646-4881-4a7f-ba3d-691dc97b479e",
"ba7aa808-6f54-484f-81bb-1f3366db4209"
],
"Opportunities": [
"f726a092-b356-4d15-92fd-de27efbcc788",
"8c5d5d0a-48e4-4d38-814b-34ef01a99863"
]
}
},
{
"Id": "014977c2-9011-41eb-85a3-ca8880d55fb0",
"SeriesId": "5d6bdcfe-106e-4430-a4b9-4a9d90a37328",
"AccessorID": "8ddab3df-defe-43e4-830d-0e42751e4803",
"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": "62005805-9bdd-4904-89c9-c8b9d45d243e",
"ScheduledByID": "15b5f118-2636-4b97-a6c8-acd2f55f84d4",
"DeletedDates": [
"2026-08-21T12:01:14Z",
"2026-08-21T12:01:14Z"
],
"ClearedDates": [
"2026-08-21T12:01:14Z",
"2026-08-21T12:01:14Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-21T12:01:14Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-21T12:01:14Z",
"CreateDate": "2026-08-21T12:01:14Z",
"OccurTime": "2026-08-21T12:01:14Z",
"OccurEndTime": "2026-08-21T12:01:14Z",
"StartTime": "2026-08-21T12:01:14Z",
"EndTime": "2026-08-21T12:01:14Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"efb13db6-0a23-4a4a-9952-ce976a436810",
"ccca7f44-6e36-433b-a67c-d619701270c9"
],
"Companies": [
"a4b9f3c6-8a46-4c3c-94cb-d30b809ed7b8",
"0966652b-dba1-4d14-8bca-524b871fd337"
],
"Groups": [
"72c8f646-4881-4a7f-ba3d-691dc97b479e",
"ba7aa808-6f54-484f-81bb-1f3366db4209"
],
"Opportunities": [
"f726a092-b356-4d15-92fd-de27efbcc788",
"8c5d5d0a-48e4-4d38-814b-34ef01a99863"
]
}
}
]