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": "1ce6f4c2-7440-4151-bfbb-c78688ae28d4",
"SeriesId": "aabbe030-fb98-464c-bd05-f7ba681b16dc",
"AccessorID": "f5b7f5da-cacf-4d69-bcd2-eeaa186d6e3c",
"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": "312d3728-add1-42b0-9dd5-4773c267840a",
"ScheduledByID": "bc37407b-961d-48dc-a38c-497d0f7dca83",
"DeletedDates": [
"2026-09-28T18:32:43Z",
"2026-09-28T18:32:43Z"
],
"ClearedDates": [
"2026-09-28T18:32:43Z",
"2026-09-28T18:32:43Z"
],
"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-28T18:32:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-28T18:32:43Z",
"CreateDate": "2026-09-28T18:32:43Z",
"OccurTime": "2026-09-28T18:32:43Z",
"OccurEndTime": "2026-09-28T18:32:43Z",
"StartTime": "2026-09-28T18:32:43Z",
"EndTime": "2026-09-28T18:32:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e3bd36a6-c6f1-4c1e-8c8b-c4a8f57c9e67",
"2524b239-be43-4761-8b5b-248fd2b18b0c"
],
"Companies": [
"532066dc-8daa-4924-99ed-5ce1f37b3b70",
"97f8b0af-3a84-4c3b-b4bd-750ec2dc3bab"
],
"Groups": [
"b7d82079-6454-4f62-a2e7-99ca64e74222",
"e7ebddf9-9788-4c13-8564-49349b328967"
],
"Opportunities": [
"d466fb6b-873f-41e3-b10e-642c4f03eafb",
"bc2289d9-f6f5-4fbf-8214-fd43287c4927"
]
}
},
{
"Id": "1ce6f4c2-7440-4151-bfbb-c78688ae28d4",
"SeriesId": "aabbe030-fb98-464c-bd05-f7ba681b16dc",
"AccessorID": "f5b7f5da-cacf-4d69-bcd2-eeaa186d6e3c",
"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": "312d3728-add1-42b0-9dd5-4773c267840a",
"ScheduledByID": "bc37407b-961d-48dc-a38c-497d0f7dca83",
"DeletedDates": [
"2026-09-28T18:32:43Z",
"2026-09-28T18:32:43Z"
],
"ClearedDates": [
"2026-09-28T18:32:43Z",
"2026-09-28T18:32:43Z"
],
"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-28T18:32:43Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-28T18:32:43Z",
"CreateDate": "2026-09-28T18:32:43Z",
"OccurTime": "2026-09-28T18:32:43Z",
"OccurEndTime": "2026-09-28T18:32:43Z",
"StartTime": "2026-09-28T18:32:43Z",
"EndTime": "2026-09-28T18:32:43Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e3bd36a6-c6f1-4c1e-8c8b-c4a8f57c9e67",
"2524b239-be43-4761-8b5b-248fd2b18b0c"
],
"Companies": [
"532066dc-8daa-4924-99ed-5ce1f37b3b70",
"97f8b0af-3a84-4c3b-b4bd-750ec2dc3bab"
],
"Groups": [
"b7d82079-6454-4f62-a2e7-99ca64e74222",
"e7ebddf9-9788-4c13-8564-49349b328967"
],
"Opportunities": [
"d466fb6b-873f-41e3-b10e-642c4f03eafb",
"bc2289d9-f6f5-4fbf-8214-fd43287c4927"
]
}
}
]