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": "868f8976-3c3c-47d1-8058-47bc4a0dcae8",
"SeriesId": "b11dbe08-27c2-4263-a7f3-f83ecdddbc24",
"AccessorID": "421b8376-bf8a-49c5-a9dd-a7d182dba22f",
"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": "774bc88e-327b-4335-8efd-4190dcd2ee23",
"ScheduledByID": "0365ad3d-3f1b-4c7e-bf33-c4d2c730fca2",
"DeletedDates": [
"2026-09-07T19:03:08Z",
"2026-09-07T19:03:08Z"
],
"ClearedDates": [
"2026-09-07T19:03:08Z",
"2026-09-07T19:03:08Z"
],
"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-07T19:03:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-07T19:03:08Z",
"CreateDate": "2026-09-07T19:03:08Z",
"OccurTime": "2026-09-07T19:03:08Z",
"OccurEndTime": "2026-09-07T19:03:08Z",
"StartTime": "2026-09-07T19:03:08Z",
"EndTime": "2026-09-07T19:03:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"928b50ac-c6e1-4a78-848e-bacbabe9e1d5",
"1349d508-4c49-4a10-929a-0f4f55fbfcd2"
],
"Companies": [
"b4c54452-8b4f-4f33-a3f1-b79b050e3054",
"edfa8005-63ad-48ae-98e3-65ac19aa4c6a"
],
"Groups": [
"47466c0d-b113-4c70-8c2a-ecc53b2c66af",
"ab1e60c3-9351-445c-8818-5b355f72f8bd"
],
"Opportunities": [
"f123e1dd-5eea-4e8f-a9fe-e84a67d97658",
"c4f4ebcc-9cd0-44ab-a48e-2d18e35b6f90"
]
}
},
{
"Id": "868f8976-3c3c-47d1-8058-47bc4a0dcae8",
"SeriesId": "b11dbe08-27c2-4263-a7f3-f83ecdddbc24",
"AccessorID": "421b8376-bf8a-49c5-a9dd-a7d182dba22f",
"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": "774bc88e-327b-4335-8efd-4190dcd2ee23",
"ScheduledByID": "0365ad3d-3f1b-4c7e-bf33-c4d2c730fca2",
"DeletedDates": [
"2026-09-07T19:03:08Z",
"2026-09-07T19:03:08Z"
],
"ClearedDates": [
"2026-09-07T19:03:08Z",
"2026-09-07T19:03:08Z"
],
"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-07T19:03:08Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-07T19:03:08Z",
"CreateDate": "2026-09-07T19:03:08Z",
"OccurTime": "2026-09-07T19:03:08Z",
"OccurEndTime": "2026-09-07T19:03:08Z",
"StartTime": "2026-09-07T19:03:08Z",
"EndTime": "2026-09-07T19:03:08Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"928b50ac-c6e1-4a78-848e-bacbabe9e1d5",
"1349d508-4c49-4a10-929a-0f4f55fbfcd2"
],
"Companies": [
"b4c54452-8b4f-4f33-a3f1-b79b050e3054",
"edfa8005-63ad-48ae-98e3-65ac19aa4c6a"
],
"Groups": [
"47466c0d-b113-4c70-8c2a-ecc53b2c66af",
"ab1e60c3-9351-445c-8818-5b355f72f8bd"
],
"Opportunities": [
"f123e1dd-5eea-4e8f-a9fe-e84a67d97658",
"c4f4ebcc-9cd0-44ab-a48e-2d18e35b6f90"
]
}
}
]