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": "6e13c06c-cc6a-43b3-95f4-75fdd524819e",
"SeriesId": "42c7c50f-d9ba-43a4-a0ac-989b2b8699ea",
"AccessorID": "a08d87c1-f8b6-4a15-8a81-2601052cddc0",
"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": "7b6dbda6-9ac2-4da8-8ef7-e11bc0bad8b0",
"ScheduledByID": "de006737-4bda-4f00-88ba-94b8d18280f4",
"DeletedDates": [
"2026-09-03T23:39:36Z",
"2026-09-03T23:39:36Z"
],
"ClearedDates": [
"2026-09-03T23:39:36Z",
"2026-09-03T23:39:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-03T23:39:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-03T23:39:37Z",
"CreateDate": "2026-09-03T23:39:37Z",
"OccurTime": "2026-09-03T23:39:37Z",
"OccurEndTime": "2026-09-03T23:39:37Z",
"StartTime": "2026-09-03T23:39:37Z",
"EndTime": "2026-09-03T23:39:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0dfe7d4b-921c-46b6-a0f7-32a5d639720a",
"4b3817bf-71c0-490b-ac45-32ee0f97ece0"
],
"Companies": [
"ba9bc2e9-eb02-49c3-92f3-9c1162079b09",
"a380df62-a974-433c-ad9b-631c1a969c09"
],
"Groups": [
"abb2c5c3-293a-4cef-929c-d8baec8851aa",
"0dea2bc3-8392-4996-8b9f-669182d40466"
],
"Opportunities": [
"94ffce96-1951-4603-95a5-d837f2b61a0f",
"ab680183-6c56-43d6-95ca-08c218919b53"
]
}
},
{
"Id": "6e13c06c-cc6a-43b3-95f4-75fdd524819e",
"SeriesId": "42c7c50f-d9ba-43a4-a0ac-989b2b8699ea",
"AccessorID": "a08d87c1-f8b6-4a15-8a81-2601052cddc0",
"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": "7b6dbda6-9ac2-4da8-8ef7-e11bc0bad8b0",
"ScheduledByID": "de006737-4bda-4f00-88ba-94b8d18280f4",
"DeletedDates": [
"2026-09-03T23:39:36Z",
"2026-09-03T23:39:36Z"
],
"ClearedDates": [
"2026-09-03T23:39:36Z",
"2026-09-03T23:39:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-03T23:39:37Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-03T23:39:37Z",
"CreateDate": "2026-09-03T23:39:37Z",
"OccurTime": "2026-09-03T23:39:37Z",
"OccurEndTime": "2026-09-03T23:39:37Z",
"StartTime": "2026-09-03T23:39:37Z",
"EndTime": "2026-09-03T23:39:37Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0dfe7d4b-921c-46b6-a0f7-32a5d639720a",
"4b3817bf-71c0-490b-ac45-32ee0f97ece0"
],
"Companies": [
"ba9bc2e9-eb02-49c3-92f3-9c1162079b09",
"a380df62-a974-433c-ad9b-631c1a969c09"
],
"Groups": [
"abb2c5c3-293a-4cef-929c-d8baec8851aa",
"0dea2bc3-8392-4996-8b9f-669182d40466"
],
"Opportunities": [
"94ffce96-1951-4603-95a5-d837f2b61a0f",
"ab680183-6c56-43d6-95ca-08c218919b53"
]
}
}
]