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": "f15c8f9c-9227-4b82-953b-fb2ffd5e7268",
"SeriesId": "116112c2-2968-4c2f-9a8c-c6b36537235d",
"AccessorID": "b5059872-dccd-4978-b502-c5aef57eb905",
"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": "468cc4e5-2fea-402a-960a-d7ae67e13d3a",
"ScheduledByID": "98dca2e0-5ef1-4a27-8d1f-df95da89082f",
"DeletedDates": [
"2026-07-17T04:32:51Z",
"2026-07-17T04:32:51Z"
],
"ClearedDates": [
"2026-07-17T04:32:51Z",
"2026-07-17T04:32:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-17T04:32:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-17T04:32:51Z",
"CreateDate": "2026-07-17T04:32:51Z",
"OccurTime": "2026-07-17T04:32:51Z",
"OccurEndTime": "2026-07-17T04:32:51Z",
"StartTime": "2026-07-17T04:32:51Z",
"EndTime": "2026-07-17T04:32:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"812c0733-3bd9-480e-81df-51227ee01108",
"ec965c79-3f7a-492e-83ac-d79d5660f400"
],
"Companies": [
"ceba1e1a-4d4d-4835-b855-da10f64f3056",
"433eb8f4-c947-4fbb-8218-090757ad4a22"
],
"Groups": [
"7cd9f738-b996-4a52-ad3f-2c79393dae25",
"13316f85-cc40-4e42-912b-d09bbd6f05fc"
],
"Opportunities": [
"0e9960e2-b7b5-4ded-9da2-fb39b98b0f29",
"22bbd68b-75af-448e-a6c5-01f9912aea19"
]
}
},
{
"Id": "f15c8f9c-9227-4b82-953b-fb2ffd5e7268",
"SeriesId": "116112c2-2968-4c2f-9a8c-c6b36537235d",
"AccessorID": "b5059872-dccd-4978-b502-c5aef57eb905",
"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": "468cc4e5-2fea-402a-960a-d7ae67e13d3a",
"ScheduledByID": "98dca2e0-5ef1-4a27-8d1f-df95da89082f",
"DeletedDates": [
"2026-07-17T04:32:51Z",
"2026-07-17T04:32:51Z"
],
"ClearedDates": [
"2026-07-17T04:32:51Z",
"2026-07-17T04:32:51Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-17T04:32:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-17T04:32:51Z",
"CreateDate": "2026-07-17T04:32:51Z",
"OccurTime": "2026-07-17T04:32:51Z",
"OccurEndTime": "2026-07-17T04:32:51Z",
"StartTime": "2026-07-17T04:32:51Z",
"EndTime": "2026-07-17T04:32:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"812c0733-3bd9-480e-81df-51227ee01108",
"ec965c79-3f7a-492e-83ac-d79d5660f400"
],
"Companies": [
"ceba1e1a-4d4d-4835-b855-da10f64f3056",
"433eb8f4-c947-4fbb-8218-090757ad4a22"
],
"Groups": [
"7cd9f738-b996-4a52-ad3f-2c79393dae25",
"13316f85-cc40-4e42-912b-d09bbd6f05fc"
],
"Opportunities": [
"0e9960e2-b7b5-4ded-9da2-fb39b98b0f29",
"22bbd68b-75af-448e-a6c5-01f9912aea19"
]
}
}
]