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": "1916cf09-4e2f-4327-85e4-1b083a45562a",
"SeriesId": "48323eca-4a94-457b-8e68-43bf0509d0f3",
"AccessorID": "c0f8ed58-605d-44ab-bbbd-bb1433d6c31f",
"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": "dd2506f7-b8be-472a-aac6-65216fb2ef51",
"ScheduledByID": "bd7d89ce-b7f7-477d-9336-c7e515eb9e41",
"DeletedDates": [
"2026-08-29T19:01:52Z",
"2026-08-29T19:01:52Z"
],
"ClearedDates": [
"2026-08-29T19:01:52Z",
"2026-08-29T19:01:52Z"
],
"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-29T19:01:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-29T19:01:52Z",
"CreateDate": "2026-08-29T19:01:52Z",
"OccurTime": "2026-08-29T19:01:52Z",
"OccurEndTime": "2026-08-29T19:01:52Z",
"StartTime": "2026-08-29T19:01:52Z",
"EndTime": "2026-08-29T19:01:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"15cc0a6e-007c-4d8e-8be4-300370cb3acf",
"32dc8c31-b04e-4921-9099-db8625d03879"
],
"Companies": [
"95b63998-ee6c-480a-92f3-92d7d5a18a0e",
"f56ee9a3-4efe-49cc-9896-3c4be70d47f0"
],
"Groups": [
"4acd2362-d653-4ab4-81aa-cd414a755b70",
"c8119e5d-b35e-4727-b223-521956ca3502"
],
"Opportunities": [
"ccf03caa-54c4-450e-b11a-53828005144f",
"08c44c1c-332f-4608-adfa-3b8d5765173a"
]
}
},
{
"Id": "1916cf09-4e2f-4327-85e4-1b083a45562a",
"SeriesId": "48323eca-4a94-457b-8e68-43bf0509d0f3",
"AccessorID": "c0f8ed58-605d-44ab-bbbd-bb1433d6c31f",
"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": "dd2506f7-b8be-472a-aac6-65216fb2ef51",
"ScheduledByID": "bd7d89ce-b7f7-477d-9336-c7e515eb9e41",
"DeletedDates": [
"2026-08-29T19:01:52Z",
"2026-08-29T19:01:52Z"
],
"ClearedDates": [
"2026-08-29T19:01:52Z",
"2026-08-29T19:01:52Z"
],
"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-29T19:01:52Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-29T19:01:52Z",
"CreateDate": "2026-08-29T19:01:52Z",
"OccurTime": "2026-08-29T19:01:52Z",
"OccurEndTime": "2026-08-29T19:01:52Z",
"StartTime": "2026-08-29T19:01:52Z",
"EndTime": "2026-08-29T19:01:52Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"15cc0a6e-007c-4d8e-8be4-300370cb3acf",
"32dc8c31-b04e-4921-9099-db8625d03879"
],
"Companies": [
"95b63998-ee6c-480a-92f3-92d7d5a18a0e",
"f56ee9a3-4efe-49cc-9896-3c4be70d47f0"
],
"Groups": [
"4acd2362-d653-4ab4-81aa-cd414a755b70",
"c8119e5d-b35e-4727-b223-521956ca3502"
],
"Opportunities": [
"ccf03caa-54c4-450e-b11a-53828005144f",
"08c44c1c-332f-4608-adfa-3b8d5765173a"
]
}
}
]