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": "52864560-5459-424f-ad88-f1af384b8e76",
"SeriesId": "3bd00aae-f185-4a54-a98d-8b4c8ccded62",
"AccessorID": "c1909c29-9380-426f-9db1-2b77af8fda0f",
"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": "555cebbd-4ad8-4cba-8121-8c760eebc79b",
"ScheduledByID": "7017b7bf-0da7-43f4-9224-7f0cb6fd105b",
"DeletedDates": [
"2026-11-03T19:01:03Z",
"2026-11-03T19:01:03Z"
],
"ClearedDates": [
"2026-11-03T19:01:03Z",
"2026-11-03T19:01:03Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-03T19:01:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-03T19:01:03Z",
"CreateDate": "2026-11-03T19:01:03Z",
"OccurTime": "2026-11-03T19:01:03Z",
"OccurEndTime": "2026-11-03T19:01:03Z",
"StartTime": "2026-11-03T19:01:03Z",
"EndTime": "2026-11-03T19:01:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f1c5bd89-74b3-4a96-a27d-abe0952f014a",
"aa314d42-2abc-456c-83a0-8006d434f335"
],
"Companies": [
"40c246af-ba21-4ed0-a4de-2ef93d462f24",
"271070cd-b323-4155-a2f9-f7acf2609b8b"
],
"Groups": [
"99e55d46-8752-47d2-b5ba-64d73b9a4ed3",
"bbbf291b-07be-47bb-8022-377db134f872"
],
"Opportunities": [
"6f7ead9a-30f4-4ed0-b36a-066e1622ae9c",
"edc65d11-f016-4372-b45b-63da3d696288"
]
}
},
{
"Id": "52864560-5459-424f-ad88-f1af384b8e76",
"SeriesId": "3bd00aae-f185-4a54-a98d-8b4c8ccded62",
"AccessorID": "c1909c29-9380-426f-9db1-2b77af8fda0f",
"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": "555cebbd-4ad8-4cba-8121-8c760eebc79b",
"ScheduledByID": "7017b7bf-0da7-43f4-9224-7f0cb6fd105b",
"DeletedDates": [
"2026-11-03T19:01:03Z",
"2026-11-03T19:01:03Z"
],
"ClearedDates": [
"2026-11-03T19:01:03Z",
"2026-11-03T19:01:03Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-03T19:01:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-03T19:01:03Z",
"CreateDate": "2026-11-03T19:01:03Z",
"OccurTime": "2026-11-03T19:01:03Z",
"OccurEndTime": "2026-11-03T19:01:03Z",
"StartTime": "2026-11-03T19:01:03Z",
"EndTime": "2026-11-03T19:01:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"f1c5bd89-74b3-4a96-a27d-abe0952f014a",
"aa314d42-2abc-456c-83a0-8006d434f335"
],
"Companies": [
"40c246af-ba21-4ed0-a4de-2ef93d462f24",
"271070cd-b323-4155-a2f9-f7acf2609b8b"
],
"Groups": [
"99e55d46-8752-47d2-b5ba-64d73b9a4ed3",
"bbbf291b-07be-47bb-8022-377db134f872"
],
"Opportunities": [
"6f7ead9a-30f4-4ed0-b36a-066e1622ae9c",
"edc65d11-f016-4372-b45b-63da3d696288"
]
}
}
]