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": "11f4e07a-8c0d-4d65-8634-295ffa725303",
"SeriesId": "f6d319c5-3cc7-4ec6-9715-cac8280c8ba4",
"AccessorID": "71ab5bcb-2cc7-4774-89d6-3d12b64481c3",
"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": "4ba5d7a8-895f-4f15-b21c-aa23aa55d962",
"ScheduledByID": "3b577cc4-8937-4d30-bda7-fa83447cdb29",
"DeletedDates": [
"2026-10-07T05:42:53Z",
"2026-10-07T05:42:53Z"
],
"ClearedDates": [
"2026-10-07T05:42:53Z",
"2026-10-07T05:42:53Z"
],
"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-07T05:42:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-07T05:42:53Z",
"CreateDate": "2026-10-07T05:42:53Z",
"OccurTime": "2026-10-07T05:42:53Z",
"OccurEndTime": "2026-10-07T05:42:53Z",
"StartTime": "2026-10-07T05:42:53Z",
"EndTime": "2026-10-07T05:42:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d2fe835-4e01-423d-9293-677c0b60f4b6",
"233535e8-5384-4713-bc0a-4b676639ea2f"
],
"Companies": [
"a2b11ffe-b1b9-449f-814e-819edaa39a6f",
"1a776312-29a5-4a05-8d47-7667eb1483a0"
],
"Groups": [
"d5b7d06f-cdba-4439-859c-8f7aaa188f78",
"794e5323-b976-44e7-99d5-6649293eeafd"
],
"Opportunities": [
"650e6097-ec84-44a2-9dfc-7f3e24b76ff2",
"5cd780b1-ea48-4204-a087-d9a908a46031"
]
}
},
{
"Id": "11f4e07a-8c0d-4d65-8634-295ffa725303",
"SeriesId": "f6d319c5-3cc7-4ec6-9715-cac8280c8ba4",
"AccessorID": "71ab5bcb-2cc7-4774-89d6-3d12b64481c3",
"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": "4ba5d7a8-895f-4f15-b21c-aa23aa55d962",
"ScheduledByID": "3b577cc4-8937-4d30-bda7-fa83447cdb29",
"DeletedDates": [
"2026-10-07T05:42:53Z",
"2026-10-07T05:42:53Z"
],
"ClearedDates": [
"2026-10-07T05:42:53Z",
"2026-10-07T05:42:53Z"
],
"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-07T05:42:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-07T05:42:53Z",
"CreateDate": "2026-10-07T05:42:53Z",
"OccurTime": "2026-10-07T05:42:53Z",
"OccurEndTime": "2026-10-07T05:42:53Z",
"StartTime": "2026-10-07T05:42:53Z",
"EndTime": "2026-10-07T05:42:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d2fe835-4e01-423d-9293-677c0b60f4b6",
"233535e8-5384-4713-bc0a-4b676639ea2f"
],
"Companies": [
"a2b11ffe-b1b9-449f-814e-819edaa39a6f",
"1a776312-29a5-4a05-8d47-7667eb1483a0"
],
"Groups": [
"d5b7d06f-cdba-4439-859c-8f7aaa188f78",
"794e5323-b976-44e7-99d5-6649293eeafd"
],
"Opportunities": [
"650e6097-ec84-44a2-9dfc-7f3e24b76ff2",
"5cd780b1-ea48-4204-a087-d9a908a46031"
]
}
}
]