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": "d9b830ef-fcd7-4d3e-ac44-61db70de33cd",
"SeriesId": "ef204f21-6542-4783-9066-30af0ecde22b",
"AccessorID": "dfc233b4-036a-4c92-a002-63797f72408b",
"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": "7e646591-23e6-4662-b495-cfb0fa20857f",
"ScheduledByID": "a1b6f196-cc7b-45d2-9489-7eb72dc2e74c",
"DeletedDates": [
"2026-04-20T09:05:09Z",
"2026-04-20T09:05:09Z"
],
"ClearedDates": [
"2026-04-20T09:05:09Z",
"2026-04-20T09:05: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-04-20T09:05:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-20T09:05:09Z",
"CreateDate": "2026-04-20T09:05:09Z",
"OccurTime": "2026-04-20T09:05:09Z",
"OccurEndTime": "2026-04-20T09:05:09Z",
"StartTime": "2026-04-20T09:05:09Z",
"EndTime": "2026-04-20T09:05:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3ce28b5f-afe5-48e8-9fff-3ff370c6bf68",
"b7f1add1-b7c1-46de-852d-1fc6b097b7e1"
],
"Companies": [
"599f1831-8621-4b35-ae2e-abcc4c01b366",
"9ef1a8ee-76a6-4330-9cc1-53b3d9e8b22d"
],
"Groups": [
"9b27ea5d-c996-4e0b-841c-d3de359a92d7",
"88750ddd-42be-41de-9a23-5c61becbe8ab"
],
"Opportunities": [
"49897e4d-d908-48e8-8928-91f39cdcc133",
"166b53d7-f4c8-4775-b034-782b2e845550"
]
}
},
{
"Id": "d9b830ef-fcd7-4d3e-ac44-61db70de33cd",
"SeriesId": "ef204f21-6542-4783-9066-30af0ecde22b",
"AccessorID": "dfc233b4-036a-4c92-a002-63797f72408b",
"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": "7e646591-23e6-4662-b495-cfb0fa20857f",
"ScheduledByID": "a1b6f196-cc7b-45d2-9489-7eb72dc2e74c",
"DeletedDates": [
"2026-04-20T09:05:09Z",
"2026-04-20T09:05:09Z"
],
"ClearedDates": [
"2026-04-20T09:05:09Z",
"2026-04-20T09:05: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-04-20T09:05:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-20T09:05:09Z",
"CreateDate": "2026-04-20T09:05:09Z",
"OccurTime": "2026-04-20T09:05:09Z",
"OccurEndTime": "2026-04-20T09:05:09Z",
"StartTime": "2026-04-20T09:05:09Z",
"EndTime": "2026-04-20T09:05:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"3ce28b5f-afe5-48e8-9fff-3ff370c6bf68",
"b7f1add1-b7c1-46de-852d-1fc6b097b7e1"
],
"Companies": [
"599f1831-8621-4b35-ae2e-abcc4c01b366",
"9ef1a8ee-76a6-4330-9cc1-53b3d9e8b22d"
],
"Groups": [
"9b27ea5d-c996-4e0b-841c-d3de359a92d7",
"88750ddd-42be-41de-9a23-5c61becbe8ab"
],
"Opportunities": [
"49897e4d-d908-48e8-8928-91f39cdcc133",
"166b53d7-f4c8-4775-b034-782b2e845550"
]
}
}
]