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": "b28c4c9b-0797-4a4a-a660-461fdd282ad8",
"SeriesId": "e5b5c24a-37b3-4787-ba96-052ed4fd7c29",
"AccessorID": "64b23c50-8291-42ae-a841-e00b55264033",
"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": "07f25252-a19d-48dc-94fe-433779a4943d",
"ScheduledByID": "0d1d54c9-86ee-4acc-abb2-893fd579cff7",
"DeletedDates": [
"2026-10-24T21:39:19Z",
"2026-10-24T21:39:19Z"
],
"ClearedDates": [
"2026-10-24T21:39:19Z",
"2026-10-24T21:39:19Z"
],
"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-24T21:39:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-24T21:39:19Z",
"CreateDate": "2026-10-24T21:39:19Z",
"OccurTime": "2026-10-24T21:39:19Z",
"OccurEndTime": "2026-10-24T21:39:19Z",
"StartTime": "2026-10-24T21:39:19Z",
"EndTime": "2026-10-24T21:39:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dab662f6-217f-4591-acd3-3d23836a6e6b",
"feb461c6-05a9-48eb-a544-41c28d85cf07"
],
"Companies": [
"185cca9f-7a52-437e-b164-15f9575f8233",
"af65f5b2-44c9-444e-9a83-b5c66146ae51"
],
"Groups": [
"f6c4220f-5fdd-42e4-acff-629b10338823",
"2d266696-093a-429a-8da4-72d0814d8b30"
],
"Opportunities": [
"bcc570b4-a4ba-4c46-9cdb-2e06f995fae6",
"30efd4f0-22ca-48eb-9ddf-f7903e1fe3b4"
]
}
},
{
"Id": "b28c4c9b-0797-4a4a-a660-461fdd282ad8",
"SeriesId": "e5b5c24a-37b3-4787-ba96-052ed4fd7c29",
"AccessorID": "64b23c50-8291-42ae-a841-e00b55264033",
"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": "07f25252-a19d-48dc-94fe-433779a4943d",
"ScheduledByID": "0d1d54c9-86ee-4acc-abb2-893fd579cff7",
"DeletedDates": [
"2026-10-24T21:39:19Z",
"2026-10-24T21:39:19Z"
],
"ClearedDates": [
"2026-10-24T21:39:19Z",
"2026-10-24T21:39:19Z"
],
"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-24T21:39:19Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-24T21:39:19Z",
"CreateDate": "2026-10-24T21:39:19Z",
"OccurTime": "2026-10-24T21:39:19Z",
"OccurEndTime": "2026-10-24T21:39:19Z",
"StartTime": "2026-10-24T21:39:19Z",
"EndTime": "2026-10-24T21:39:19Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"dab662f6-217f-4591-acd3-3d23836a6e6b",
"feb461c6-05a9-48eb-a544-41c28d85cf07"
],
"Companies": [
"185cca9f-7a52-437e-b164-15f9575f8233",
"af65f5b2-44c9-444e-9a83-b5c66146ae51"
],
"Groups": [
"f6c4220f-5fdd-42e4-acff-629b10338823",
"2d266696-093a-429a-8da4-72d0814d8b30"
],
"Opportunities": [
"bcc570b4-a4ba-4c46-9cdb-2e06f995fae6",
"30efd4f0-22ca-48eb-9ddf-f7903e1fe3b4"
]
}
}
]