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": "b8352d4b-0b79-4718-82d6-fa8aa3008166",
"SeriesId": "a4b6d70e-b752-4d99-991f-dc0c1d46553a",
"AccessorID": "5909ceff-4249-452f-a6e6-7d4e47892716",
"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": "177364ba-3a43-49bd-9bdb-ad84fdb5b1f2",
"ScheduledByID": "b4184f16-13df-4773-af51-c368926c3fa8",
"DeletedDates": [
"2026-09-10T05:41:39Z",
"2026-09-10T05:41:39Z"
],
"ClearedDates": [
"2026-09-10T05:41:39Z",
"2026-09-10T05:41:39Z"
],
"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-10T05:41:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-10T05:41:39Z",
"CreateDate": "2026-09-10T05:41:39Z",
"OccurTime": "2026-09-10T05:41:39Z",
"OccurEndTime": "2026-09-10T05:41:39Z",
"StartTime": "2026-09-10T05:41:39Z",
"EndTime": "2026-09-10T05:41:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a24fa890-657d-48fe-91f8-b4539095a334",
"8299bd4e-95f4-491b-a18a-8c932330f47a"
],
"Companies": [
"6d5fbe66-0aa7-41e2-8807-0b76a2396bba",
"1a711338-af55-4682-9868-f30a8d610355"
],
"Groups": [
"d3b76709-ed66-403b-ac42-5b93e98210c6",
"fb4b31cc-bece-42ec-b742-d384da53e117"
],
"Opportunities": [
"e75084d7-6e47-42c0-9af7-1549249756b0",
"1330549f-1d27-4027-b75d-45dea141430b"
]
}
},
{
"Id": "b8352d4b-0b79-4718-82d6-fa8aa3008166",
"SeriesId": "a4b6d70e-b752-4d99-991f-dc0c1d46553a",
"AccessorID": "5909ceff-4249-452f-a6e6-7d4e47892716",
"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": "177364ba-3a43-49bd-9bdb-ad84fdb5b1f2",
"ScheduledByID": "b4184f16-13df-4773-af51-c368926c3fa8",
"DeletedDates": [
"2026-09-10T05:41:39Z",
"2026-09-10T05:41:39Z"
],
"ClearedDates": [
"2026-09-10T05:41:39Z",
"2026-09-10T05:41:39Z"
],
"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-10T05:41:39Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-10T05:41:39Z",
"CreateDate": "2026-09-10T05:41:39Z",
"OccurTime": "2026-09-10T05:41:39Z",
"OccurEndTime": "2026-09-10T05:41:39Z",
"StartTime": "2026-09-10T05:41:39Z",
"EndTime": "2026-09-10T05:41:39Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a24fa890-657d-48fe-91f8-b4539095a334",
"8299bd4e-95f4-491b-a18a-8c932330f47a"
],
"Companies": [
"6d5fbe66-0aa7-41e2-8807-0b76a2396bba",
"1a711338-af55-4682-9868-f30a8d610355"
],
"Groups": [
"d3b76709-ed66-403b-ac42-5b93e98210c6",
"fb4b31cc-bece-42ec-b742-d384da53e117"
],
"Opportunities": [
"e75084d7-6e47-42c0-9af7-1549249756b0",
"1330549f-1d27-4027-b75d-45dea141430b"
]
}
}
]