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": "4101390a-9fc0-46bf-b962-653c8a73dcfc",
"SeriesId": "18f41be0-c0f6-4da7-8097-1a97289113f1",
"AccessorID": "2d697fc9-8fef-4413-94cb-8a9bfb489428",
"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": "24c38635-812f-4980-bd6a-614dd9d0b73b",
"ScheduledByID": "17b69cd4-2d65-4ef3-80d3-ae2c9c9571e7",
"DeletedDates": [
"2026-08-08T05:29:57Z",
"2026-08-08T05:29:57Z"
],
"ClearedDates": [
"2026-08-08T05:29:57Z",
"2026-08-08T05:29:57Z"
],
"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-08T05:29:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-08T05:29:57Z",
"CreateDate": "2026-08-08T05:29:57Z",
"OccurTime": "2026-08-08T05:29:57Z",
"OccurEndTime": "2026-08-08T05:29:57Z",
"StartTime": "2026-08-08T05:29:57Z",
"EndTime": "2026-08-08T05:29:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"619f619f-a4d2-4066-8d71-0e116b259e23",
"3260917c-94a5-4218-8d4f-d9e5ba536d68"
],
"Companies": [
"1f59821a-88af-4d33-befe-19171bb10dad",
"f0adaf3d-eb4d-43a3-937b-55cbcb8c253e"
],
"Groups": [
"0ded0d40-c33e-427e-b9e0-056f8187c6a1",
"af0f1afa-0004-4751-88b9-3fd5be9b6e8c"
],
"Opportunities": [
"ff24df54-8879-45ba-aff0-dc081e732a42",
"fdf3ee5f-3849-4dbe-9246-e28d212559d7"
]
}
},
{
"Id": "4101390a-9fc0-46bf-b962-653c8a73dcfc",
"SeriesId": "18f41be0-c0f6-4da7-8097-1a97289113f1",
"AccessorID": "2d697fc9-8fef-4413-94cb-8a9bfb489428",
"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": "24c38635-812f-4980-bd6a-614dd9d0b73b",
"ScheduledByID": "17b69cd4-2d65-4ef3-80d3-ae2c9c9571e7",
"DeletedDates": [
"2026-08-08T05:29:57Z",
"2026-08-08T05:29:57Z"
],
"ClearedDates": [
"2026-08-08T05:29:57Z",
"2026-08-08T05:29:57Z"
],
"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-08T05:29:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-08T05:29:57Z",
"CreateDate": "2026-08-08T05:29:57Z",
"OccurTime": "2026-08-08T05:29:57Z",
"OccurEndTime": "2026-08-08T05:29:57Z",
"StartTime": "2026-08-08T05:29:57Z",
"EndTime": "2026-08-08T05:29:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"619f619f-a4d2-4066-8d71-0e116b259e23",
"3260917c-94a5-4218-8d4f-d9e5ba536d68"
],
"Companies": [
"1f59821a-88af-4d33-befe-19171bb10dad",
"f0adaf3d-eb4d-43a3-937b-55cbcb8c253e"
],
"Groups": [
"0ded0d40-c33e-427e-b9e0-056f8187c6a1",
"af0f1afa-0004-4751-88b9-3fd5be9b6e8c"
],
"Opportunities": [
"ff24df54-8879-45ba-aff0-dc081e732a42",
"fdf3ee5f-3849-4dbe-9246-e28d212559d7"
]
}
}
]