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": "8c1993e9-0b21-4424-8f72-241b452eb4aa",
"SeriesId": "3d3bc2e6-1e33-4f9f-b0f7-ba4a3defb7f3",
"AccessorID": "bbb66436-2b09-4167-af62-ca3f0d8d718a",
"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": "1db808c5-23d4-4188-9bea-c9fd011b0c4f",
"ScheduledByID": "30722f2f-0f95-4494-8939-6bbb5b3a08af",
"DeletedDates": [
"2026-10-05T07:30:36Z",
"2026-10-05T07:30:36Z"
],
"ClearedDates": [
"2026-10-05T07:30:36Z",
"2026-10-05T07:30:36Z"
],
"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-05T07:30:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-05T07:30:36Z",
"CreateDate": "2026-10-05T07:30:36Z",
"OccurTime": "2026-10-05T07:30:36Z",
"OccurEndTime": "2026-10-05T07:30:36Z",
"StartTime": "2026-10-05T07:30:36Z",
"EndTime": "2026-10-05T07:30:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bf73dab7-c51d-48ae-a7fe-bee92a2729ef",
"2d966be6-769d-4061-9d4d-a9ee202d68a0"
],
"Companies": [
"ec3527cf-aa66-46b6-a919-951ff25384f0",
"f560a720-6309-4422-8a47-1bfac2916511"
],
"Groups": [
"e6378ff5-d00b-4369-9640-b693a5e062b4",
"32da5278-e8db-4263-bc4f-b41592a8284f"
],
"Opportunities": [
"30602f51-522f-4d5d-be05-1220e32c2a93",
"d693959c-8917-4765-9863-e9213ee6e2d0"
]
}
},
{
"Id": "8c1993e9-0b21-4424-8f72-241b452eb4aa",
"SeriesId": "3d3bc2e6-1e33-4f9f-b0f7-ba4a3defb7f3",
"AccessorID": "bbb66436-2b09-4167-af62-ca3f0d8d718a",
"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": "1db808c5-23d4-4188-9bea-c9fd011b0c4f",
"ScheduledByID": "30722f2f-0f95-4494-8939-6bbb5b3a08af",
"DeletedDates": [
"2026-10-05T07:30:36Z",
"2026-10-05T07:30:36Z"
],
"ClearedDates": [
"2026-10-05T07:30:36Z",
"2026-10-05T07:30:36Z"
],
"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-05T07:30:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-05T07:30:36Z",
"CreateDate": "2026-10-05T07:30:36Z",
"OccurTime": "2026-10-05T07:30:36Z",
"OccurEndTime": "2026-10-05T07:30:36Z",
"StartTime": "2026-10-05T07:30:36Z",
"EndTime": "2026-10-05T07:30:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"bf73dab7-c51d-48ae-a7fe-bee92a2729ef",
"2d966be6-769d-4061-9d4d-a9ee202d68a0"
],
"Companies": [
"ec3527cf-aa66-46b6-a919-951ff25384f0",
"f560a720-6309-4422-8a47-1bfac2916511"
],
"Groups": [
"e6378ff5-d00b-4369-9640-b693a5e062b4",
"32da5278-e8db-4263-bc4f-b41592a8284f"
],
"Opportunities": [
"30602f51-522f-4d5d-be05-1220e32c2a93",
"d693959c-8917-4765-9863-e9213ee6e2d0"
]
}
}
]