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": "9810f47e-afa0-409a-b3f2-7dc2b7fe7b3f",
"SeriesId": "2b1c81a6-0e32-415b-b2f9-a7488bd09f60",
"AccessorID": "dc3d5357-c673-490b-9711-def50ed4a8b2",
"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": "6900cee3-198c-414f-ab7f-8e0d68d66811",
"ScheduledByID": "59d2dfa7-b697-4e8d-afad-d1531d7dc79d",
"DeletedDates": [
"2026-09-06T15:23:43Z",
"2026-09-06T15:23:43Z"
],
"ClearedDates": [
"2026-09-06T15:23:43Z",
"2026-09-06T15:23:43Z"
],
"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-06T15:23:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-06T15:23:43Z",
"CreateDate": "2026-09-06T15:23:43Z",
"OccurTime": "2026-09-06T15:23:43Z",
"OccurEndTime": "2026-09-06T15:23:43Z",
"StartTime": "2026-09-06T15:23:43Z",
"EndTime": "2026-09-06T15:23:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ee82aa47-f580-4872-9c3c-0ae98fbba53a",
"cfe832fd-a3c1-4da2-890f-dc5b4f9510e1"
],
"Companies": [
"da5d29cf-7587-49f5-a168-af7b86472b4a",
"1072a493-3fe9-4d09-9e34-82b39ab02d04"
],
"Groups": [
"5c1f9a75-7488-45bb-a434-e812650f108d",
"d94a719c-acd2-4bb6-a189-78cb54237bf9"
],
"Opportunities": [
"87d795ae-4e73-4f41-973f-4cb57c8e81df",
"78bae04b-7734-4263-b230-adf5275dcb3e"
]
}
},
{
"Id": "9810f47e-afa0-409a-b3f2-7dc2b7fe7b3f",
"SeriesId": "2b1c81a6-0e32-415b-b2f9-a7488bd09f60",
"AccessorID": "dc3d5357-c673-490b-9711-def50ed4a8b2",
"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": "6900cee3-198c-414f-ab7f-8e0d68d66811",
"ScheduledByID": "59d2dfa7-b697-4e8d-afad-d1531d7dc79d",
"DeletedDates": [
"2026-09-06T15:23:43Z",
"2026-09-06T15:23:43Z"
],
"ClearedDates": [
"2026-09-06T15:23:43Z",
"2026-09-06T15:23:43Z"
],
"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-06T15:23:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-06T15:23:43Z",
"CreateDate": "2026-09-06T15:23:43Z",
"OccurTime": "2026-09-06T15:23:43Z",
"OccurEndTime": "2026-09-06T15:23:43Z",
"StartTime": "2026-09-06T15:23:43Z",
"EndTime": "2026-09-06T15:23:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ee82aa47-f580-4872-9c3c-0ae98fbba53a",
"cfe832fd-a3c1-4da2-890f-dc5b4f9510e1"
],
"Companies": [
"da5d29cf-7587-49f5-a168-af7b86472b4a",
"1072a493-3fe9-4d09-9e34-82b39ab02d04"
],
"Groups": [
"5c1f9a75-7488-45bb-a434-e812650f108d",
"d94a719c-acd2-4bb6-a189-78cb54237bf9"
],
"Opportunities": [
"87d795ae-4e73-4f41-973f-4cb57c8e81df",
"78bae04b-7734-4263-b230-adf5275dcb3e"
]
}
}
]