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": "08ad0f1a-7a41-4248-b0a0-dd105f942b29",
"SeriesId": "03238a6e-a0f0-4bd9-9f5a-b1c13a192dca",
"AccessorID": "c140a2dd-5e86-488d-b7d5-67bddfaeba1f",
"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": "1634a8f9-f18a-4197-bbb5-64d3498ca38c",
"ScheduledByID": "db64b021-4ed8-445a-9099-64818cadb559",
"DeletedDates": [
"2026-05-03T09:42:33Z",
"2026-05-03T09:42:33Z"
],
"ClearedDates": [
"2026-05-03T09:42:33Z",
"2026-05-03T09:42:33Z"
],
"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-03T09:42:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-03T09:42:33Z",
"CreateDate": "2026-05-03T09:42:33Z",
"OccurTime": "2026-05-03T09:42:33Z",
"OccurEndTime": "2026-05-03T09:42:33Z",
"StartTime": "2026-05-03T09:42:33Z",
"EndTime": "2026-05-03T09:42:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7b7e0483-9724-4d09-af65-f3b4d2c9c9de",
"f34365a7-960d-493e-9fab-608ebb738391"
],
"Companies": [
"d54305dd-0824-4add-bfe4-5d9e3ef3477e",
"a9b606bc-e70b-4641-aa19-0efc03f6fda2"
],
"Groups": [
"a3abc69f-fea6-487f-8845-09726c5c1247",
"c175e451-5f6e-4ef3-ab4b-8b6dc816049b"
],
"Opportunities": [
"365839dd-f9f2-4826-9318-54cd9b6cc8ba",
"d2dc5ae6-704d-4ea0-9dad-b734b051dad7"
]
}
},
{
"Id": "08ad0f1a-7a41-4248-b0a0-dd105f942b29",
"SeriesId": "03238a6e-a0f0-4bd9-9f5a-b1c13a192dca",
"AccessorID": "c140a2dd-5e86-488d-b7d5-67bddfaeba1f",
"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": "1634a8f9-f18a-4197-bbb5-64d3498ca38c",
"ScheduledByID": "db64b021-4ed8-445a-9099-64818cadb559",
"DeletedDates": [
"2026-05-03T09:42:33Z",
"2026-05-03T09:42:33Z"
],
"ClearedDates": [
"2026-05-03T09:42:33Z",
"2026-05-03T09:42:33Z"
],
"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-03T09:42:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-03T09:42:33Z",
"CreateDate": "2026-05-03T09:42:33Z",
"OccurTime": "2026-05-03T09:42:33Z",
"OccurEndTime": "2026-05-03T09:42:33Z",
"StartTime": "2026-05-03T09:42:33Z",
"EndTime": "2026-05-03T09:42:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7b7e0483-9724-4d09-af65-f3b4d2c9c9de",
"f34365a7-960d-493e-9fab-608ebb738391"
],
"Companies": [
"d54305dd-0824-4add-bfe4-5d9e3ef3477e",
"a9b606bc-e70b-4641-aa19-0efc03f6fda2"
],
"Groups": [
"a3abc69f-fea6-487f-8845-09726c5c1247",
"c175e451-5f6e-4ef3-ab4b-8b6dc816049b"
],
"Opportunities": [
"365839dd-f9f2-4826-9318-54cd9b6cc8ba",
"d2dc5ae6-704d-4ea0-9dad-b734b051dad7"
]
}
}
]