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": "3e408e16-1a08-4472-877f-24cabed27d7e",
"SeriesId": "b149bfc5-7cf2-44a2-a512-0fae05c5f0bc",
"AccessorID": "2a5b1340-f371-4d05-b14d-c3a531a1009f",
"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": "ddf4358e-ac0c-4f1b-8c5b-9e8fea2076ff",
"ScheduledByID": "a0feed27-f076-4696-9c50-c7da95b71595",
"DeletedDates": [
"2026-05-19T14:12:55Z",
"2026-05-19T14:12:55Z"
],
"ClearedDates": [
"2026-05-19T14:12:55Z",
"2026-05-19T14:12:55Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-19T14:12:55Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-19T14:12:55Z",
"CreateDate": "2026-05-19T14:12:55Z",
"OccurTime": "2026-05-19T14:12:55Z",
"OccurEndTime": "2026-05-19T14:12:55Z",
"StartTime": "2026-05-19T14:12:55Z",
"EndTime": "2026-05-19T14:12:55Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d2d67675-4bf3-4f9d-8880-37ca1c8bf264",
"c19237fe-fcc7-4849-bd25-8a2de2feb949"
],
"Companies": [
"9b508bed-8b10-450b-b141-7fa0cc3d79c3",
"eb6c0260-7bd9-495e-9b17-2bd9cf498196"
],
"Groups": [
"9d51bb11-000a-48b5-9449-ccb05d91527d",
"053855bf-728e-425d-a48e-f420333ef947"
],
"Opportunities": [
"ba1b8869-62f8-499c-a85f-11416e4215c3",
"44da62b4-3716-4b8e-b2c3-4b356ee45b88"
]
}
},
{
"Id": "3e408e16-1a08-4472-877f-24cabed27d7e",
"SeriesId": "b149bfc5-7cf2-44a2-a512-0fae05c5f0bc",
"AccessorID": "2a5b1340-f371-4d05-b14d-c3a531a1009f",
"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": "ddf4358e-ac0c-4f1b-8c5b-9e8fea2076ff",
"ScheduledByID": "a0feed27-f076-4696-9c50-c7da95b71595",
"DeletedDates": [
"2026-05-19T14:12:55Z",
"2026-05-19T14:12:55Z"
],
"ClearedDates": [
"2026-05-19T14:12:55Z",
"2026-05-19T14:12:55Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-05-19T14:12:55Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-19T14:12:55Z",
"CreateDate": "2026-05-19T14:12:55Z",
"OccurTime": "2026-05-19T14:12:55Z",
"OccurEndTime": "2026-05-19T14:12:55Z",
"StartTime": "2026-05-19T14:12:55Z",
"EndTime": "2026-05-19T14:12:55Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"d2d67675-4bf3-4f9d-8880-37ca1c8bf264",
"c19237fe-fcc7-4849-bd25-8a2de2feb949"
],
"Companies": [
"9b508bed-8b10-450b-b141-7fa0cc3d79c3",
"eb6c0260-7bd9-495e-9b17-2bd9cf498196"
],
"Groups": [
"9d51bb11-000a-48b5-9449-ccb05d91527d",
"053855bf-728e-425d-a48e-f420333ef947"
],
"Opportunities": [
"ba1b8869-62f8-499c-a85f-11416e4215c3",
"44da62b4-3716-4b8e-b2c3-4b356ee45b88"
]
}
}
]