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": "53238b57-330c-42a6-b187-4aa4d426a28f",
"SeriesId": "6a42864f-ccbd-44ea-9f66-c2da59b7366f",
"AccessorID": "df3c69de-e7c5-4148-a331-209301b75b71",
"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": "ab999ec2-8b14-47b8-afc9-ae08cb5b160f",
"ScheduledByID": "95959f5e-78a0-4106-8b5f-264462750e53",
"DeletedDates": [
"2026-10-07T18:55:45Z",
"2026-10-07T18:55:45Z"
],
"ClearedDates": [
"2026-10-07T18:55:45Z",
"2026-10-07T18:55:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-07T18:55:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-07T18:55:45Z",
"CreateDate": "2026-10-07T18:55:45Z",
"OccurTime": "2026-10-07T18:55:45Z",
"OccurEndTime": "2026-10-07T18:55:45Z",
"StartTime": "2026-10-07T18:55:45Z",
"EndTime": "2026-10-07T18:55:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4bb5fa40-867f-4c1a-8475-9e86accc0f48",
"ae589fa5-0208-4a8c-88ac-1116d5cf2461"
],
"Companies": [
"314e7be4-865c-4588-a606-c5a501bc21bf",
"7f29b693-6bd5-4352-8a2c-7f66e963f4c9"
],
"Groups": [
"c8921e33-ec9f-4b46-bd61-b3a6abb76ac3",
"cc16d7b9-d8a0-499f-bd15-5ef9c5c03300"
],
"Opportunities": [
"dfe546b3-6351-4773-8201-368bd0dbfca7",
"a73c11c8-919b-4ec2-9583-cbc3781c0d7e"
]
}
},
{
"Id": "53238b57-330c-42a6-b187-4aa4d426a28f",
"SeriesId": "6a42864f-ccbd-44ea-9f66-c2da59b7366f",
"AccessorID": "df3c69de-e7c5-4148-a331-209301b75b71",
"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": "ab999ec2-8b14-47b8-afc9-ae08cb5b160f",
"ScheduledByID": "95959f5e-78a0-4106-8b5f-264462750e53",
"DeletedDates": [
"2026-10-07T18:55:45Z",
"2026-10-07T18:55:45Z"
],
"ClearedDates": [
"2026-10-07T18:55:45Z",
"2026-10-07T18:55:45Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-07T18:55:45Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-07T18:55:45Z",
"CreateDate": "2026-10-07T18:55:45Z",
"OccurTime": "2026-10-07T18:55:45Z",
"OccurEndTime": "2026-10-07T18:55:45Z",
"StartTime": "2026-10-07T18:55:45Z",
"EndTime": "2026-10-07T18:55:45Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"4bb5fa40-867f-4c1a-8475-9e86accc0f48",
"ae589fa5-0208-4a8c-88ac-1116d5cf2461"
],
"Companies": [
"314e7be4-865c-4588-a606-c5a501bc21bf",
"7f29b693-6bd5-4352-8a2c-7f66e963f4c9"
],
"Groups": [
"c8921e33-ec9f-4b46-bd61-b3a6abb76ac3",
"cc16d7b9-d8a0-499f-bd15-5ef9c5c03300"
],
"Opportunities": [
"dfe546b3-6351-4773-8201-368bd0dbfca7",
"a73c11c8-919b-4ec2-9583-cbc3781c0d7e"
]
}
}
]