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": "a3182e51-4ab2-4990-8319-9cdf45a0a436",
"SeriesId": "8ca9df29-0084-4df8-aaed-24ffcfdde3f2",
"AccessorID": "3850b9f5-1861-48e0-bea1-4dafbb86b9df",
"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": "b04f2e5d-2057-4b9f-8c1d-8a2bbf23e3aa",
"ScheduledByID": "0c06d316-7f0a-4930-a413-984d9da9ccc6",
"DeletedDates": [
"2026-08-27T17:57:03Z",
"2026-08-27T17:57:03Z"
],
"ClearedDates": [
"2026-08-27T17:57:03Z",
"2026-08-27T17:57: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-08-27T17:57:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-27T17:57:03Z",
"CreateDate": "2026-08-27T17:57:03Z",
"OccurTime": "2026-08-27T17:57:03Z",
"OccurEndTime": "2026-08-27T17:57:03Z",
"StartTime": "2026-08-27T17:57:03Z",
"EndTime": "2026-08-27T17:57:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"58ca070a-18b0-4d06-98a2-b0eec97c145d",
"ed8f0b9e-d027-4672-8fa5-64ce3de292ff"
],
"Companies": [
"64dd5659-a621-4049-8b63-e98e15aac63a",
"167312e4-9c38-40ce-ab00-f4b50c6f2e27"
],
"Groups": [
"181024f3-0ff9-41f9-b46b-90fded93be2d",
"cc0c6ff4-1b62-4073-a4e1-583868399316"
],
"Opportunities": [
"34073acb-e0f1-48b3-a303-c3b60b4806a2",
"1ff9613f-9764-4bf6-b48b-02a26c5c39f8"
]
}
},
{
"Id": "a3182e51-4ab2-4990-8319-9cdf45a0a436",
"SeriesId": "8ca9df29-0084-4df8-aaed-24ffcfdde3f2",
"AccessorID": "3850b9f5-1861-48e0-bea1-4dafbb86b9df",
"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": "b04f2e5d-2057-4b9f-8c1d-8a2bbf23e3aa",
"ScheduledByID": "0c06d316-7f0a-4930-a413-984d9da9ccc6",
"DeletedDates": [
"2026-08-27T17:57:03Z",
"2026-08-27T17:57:03Z"
],
"ClearedDates": [
"2026-08-27T17:57:03Z",
"2026-08-27T17:57: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-08-27T17:57:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-27T17:57:03Z",
"CreateDate": "2026-08-27T17:57:03Z",
"OccurTime": "2026-08-27T17:57:03Z",
"OccurEndTime": "2026-08-27T17:57:03Z",
"StartTime": "2026-08-27T17:57:03Z",
"EndTime": "2026-08-27T17:57:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"58ca070a-18b0-4d06-98a2-b0eec97c145d",
"ed8f0b9e-d027-4672-8fa5-64ce3de292ff"
],
"Companies": [
"64dd5659-a621-4049-8b63-e98e15aac63a",
"167312e4-9c38-40ce-ab00-f4b50c6f2e27"
],
"Groups": [
"181024f3-0ff9-41f9-b46b-90fded93be2d",
"cc0c6ff4-1b62-4073-a4e1-583868399316"
],
"Opportunities": [
"34073acb-e0f1-48b3-a303-c3b60b4806a2",
"1ff9613f-9764-4bf6-b48b-02a26c5c39f8"
]
}
}
]