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": "18f5456b-3c63-4ac8-bef4-836e91055940",
"SeriesId": "d11e0dc2-879c-41e6-a444-44b7345fa7d9",
"AccessorID": "3a588927-4a3f-4d31-806f-048001bc0a85",
"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": "28e806ec-f1ea-400d-9331-d7d10f3ca5b4",
"ScheduledByID": "24859c70-69b0-493e-902c-37118f9cbee8",
"DeletedDates": [
"2026-07-08T21:56:20Z",
"2026-07-08T21:56:20Z"
],
"ClearedDates": [
"2026-07-08T21:56:20Z",
"2026-07-08T21:56:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-08T21:56:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-08T21:56:20Z",
"CreateDate": "2026-07-08T21:56:20Z",
"OccurTime": "2026-07-08T21:56:20Z",
"OccurEndTime": "2026-07-08T21:56:20Z",
"StartTime": "2026-07-08T21:56:20Z",
"EndTime": "2026-07-08T21:56:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"14f49974-c8fe-47a7-a596-691a3fe93db2",
"746b0152-14e4-4e5d-aaa1-85066b69cd39"
],
"Companies": [
"4062d96c-e915-4643-ad1b-7cad13ee8ded",
"b29b1287-1350-4a9f-b034-8116543532df"
],
"Groups": [
"e489059b-17b3-4212-891a-f2d4b155e9df",
"81151059-9513-4942-89c2-78719ba72eef"
],
"Opportunities": [
"c986f26d-c1cc-471c-ad44-5b0d73330877",
"e30656b1-8705-4fc1-bbbb-a646b73185df"
]
}
},
{
"Id": "18f5456b-3c63-4ac8-bef4-836e91055940",
"SeriesId": "d11e0dc2-879c-41e6-a444-44b7345fa7d9",
"AccessorID": "3a588927-4a3f-4d31-806f-048001bc0a85",
"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": "28e806ec-f1ea-400d-9331-d7d10f3ca5b4",
"ScheduledByID": "24859c70-69b0-493e-902c-37118f9cbee8",
"DeletedDates": [
"2026-07-08T21:56:20Z",
"2026-07-08T21:56:20Z"
],
"ClearedDates": [
"2026-07-08T21:56:20Z",
"2026-07-08T21:56:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-08T21:56:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-08T21:56:20Z",
"CreateDate": "2026-07-08T21:56:20Z",
"OccurTime": "2026-07-08T21:56:20Z",
"OccurEndTime": "2026-07-08T21:56:20Z",
"StartTime": "2026-07-08T21:56:20Z",
"EndTime": "2026-07-08T21:56:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"14f49974-c8fe-47a7-a596-691a3fe93db2",
"746b0152-14e4-4e5d-aaa1-85066b69cd39"
],
"Companies": [
"4062d96c-e915-4643-ad1b-7cad13ee8ded",
"b29b1287-1350-4a9f-b034-8116543532df"
],
"Groups": [
"e489059b-17b3-4212-891a-f2d4b155e9df",
"81151059-9513-4942-89c2-78719ba72eef"
],
"Opportunities": [
"c986f26d-c1cc-471c-ad44-5b0d73330877",
"e30656b1-8705-4fc1-bbbb-a646b73185df"
]
}
}
]