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": "29c22005-42c6-4daf-86f9-ed2a10aed34d",
"SeriesId": "1b1a10c3-b37a-456c-938b-760f2cd3cacd",
"AccessorID": "0215ae13-0740-4a1d-838c-3482aea8e141",
"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": "06d26b0b-1515-4e8b-9d04-b2a25d6d6597",
"ScheduledByID": "91d78237-e6b2-4781-941a-886165af8574",
"DeletedDates": [
"2026-07-06T21:11:58Z",
"2026-07-06T21:11:58Z"
],
"ClearedDates": [
"2026-07-06T21:11:58Z",
"2026-07-06T21:11:58Z"
],
"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-06T21:11:58Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-06T21:11:58Z",
"CreateDate": "2026-07-06T21:11:58Z",
"OccurTime": "2026-07-06T21:11:58Z",
"OccurEndTime": "2026-07-06T21:11:58Z",
"StartTime": "2026-07-06T21:11:58Z",
"EndTime": "2026-07-06T21:11:58Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a8449538-d4a3-42fc-8694-577e4765124c",
"baa9bb6f-46d0-4be3-aab5-5f581ef9098b"
],
"Companies": [
"a2b05343-477d-44eb-b4c0-1289a625502e",
"091dea99-98a6-4f21-b330-67b75e3f7043"
],
"Groups": [
"7b1ebbaf-c938-4862-bb7a-8c248b93c9a0",
"34d05652-5ebc-42ec-8eeb-91b8659b033d"
],
"Opportunities": [
"cc262aec-7c7b-4e71-830d-133337934e46",
"2dea4567-4b9d-409c-b438-6c3901f90830"
]
}
},
{
"Id": "29c22005-42c6-4daf-86f9-ed2a10aed34d",
"SeriesId": "1b1a10c3-b37a-456c-938b-760f2cd3cacd",
"AccessorID": "0215ae13-0740-4a1d-838c-3482aea8e141",
"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": "06d26b0b-1515-4e8b-9d04-b2a25d6d6597",
"ScheduledByID": "91d78237-e6b2-4781-941a-886165af8574",
"DeletedDates": [
"2026-07-06T21:11:58Z",
"2026-07-06T21:11:58Z"
],
"ClearedDates": [
"2026-07-06T21:11:58Z",
"2026-07-06T21:11:58Z"
],
"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-06T21:11:58Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-06T21:11:58Z",
"CreateDate": "2026-07-06T21:11:58Z",
"OccurTime": "2026-07-06T21:11:58Z",
"OccurEndTime": "2026-07-06T21:11:58Z",
"StartTime": "2026-07-06T21:11:58Z",
"EndTime": "2026-07-06T21:11:58Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a8449538-d4a3-42fc-8694-577e4765124c",
"baa9bb6f-46d0-4be3-aab5-5f581ef9098b"
],
"Companies": [
"a2b05343-477d-44eb-b4c0-1289a625502e",
"091dea99-98a6-4f21-b330-67b75e3f7043"
],
"Groups": [
"7b1ebbaf-c938-4862-bb7a-8c248b93c9a0",
"34d05652-5ebc-42ec-8eeb-91b8659b033d"
],
"Opportunities": [
"cc262aec-7c7b-4e71-830d-133337934e46",
"2dea4567-4b9d-409c-b438-6c3901f90830"
]
}
}
]