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": "2c010c29-7901-4ea3-bcbe-040d78203fc5",
"SeriesId": "bae41499-43f6-4721-8854-1f811409b271",
"AccessorID": "4710df75-4d35-4f4a-807c-b2fba1efb14d",
"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": "1814f748-6735-4f39-a7b4-408803e34780",
"ScheduledByID": "c86ed6b2-669b-4401-a8cf-7b1775a30af5",
"DeletedDates": [
"2026-08-25T15:42:28Z",
"2026-08-25T15:42:28Z"
],
"ClearedDates": [
"2026-08-25T15:42:28Z",
"2026-08-25T15:42:28Z"
],
"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-25T15:42:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-25T15:42:28Z",
"CreateDate": "2026-08-25T15:42:28Z",
"OccurTime": "2026-08-25T15:42:28Z",
"OccurEndTime": "2026-08-25T15:42:28Z",
"StartTime": "2026-08-25T15:42:28Z",
"EndTime": "2026-08-25T15:42:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ff5fe4b9-2009-45b6-a49c-030b28e62034",
"1cff6792-457a-41f5-a6bf-2e30769c15ac"
],
"Companies": [
"3ada9fa2-5a9a-457b-a378-5c3681d0617f",
"c4dc0bf9-aafc-44b1-acfc-c4454dcf7e27"
],
"Groups": [
"882e96e9-5ee9-428b-a5ea-d97c1f20f874",
"a64701ed-7c1a-459b-93ed-8c3f6538fbff"
],
"Opportunities": [
"47512570-58c2-4856-8947-17bdcdbc5110",
"2b1fae30-bd7d-451a-835a-f1c198f445f8"
]
}
},
{
"Id": "2c010c29-7901-4ea3-bcbe-040d78203fc5",
"SeriesId": "bae41499-43f6-4721-8854-1f811409b271",
"AccessorID": "4710df75-4d35-4f4a-807c-b2fba1efb14d",
"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": "1814f748-6735-4f39-a7b4-408803e34780",
"ScheduledByID": "c86ed6b2-669b-4401-a8cf-7b1775a30af5",
"DeletedDates": [
"2026-08-25T15:42:28Z",
"2026-08-25T15:42:28Z"
],
"ClearedDates": [
"2026-08-25T15:42:28Z",
"2026-08-25T15:42:28Z"
],
"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-25T15:42:28Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-25T15:42:28Z",
"CreateDate": "2026-08-25T15:42:28Z",
"OccurTime": "2026-08-25T15:42:28Z",
"OccurEndTime": "2026-08-25T15:42:28Z",
"StartTime": "2026-08-25T15:42:28Z",
"EndTime": "2026-08-25T15:42:28Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ff5fe4b9-2009-45b6-a49c-030b28e62034",
"1cff6792-457a-41f5-a6bf-2e30769c15ac"
],
"Companies": [
"3ada9fa2-5a9a-457b-a378-5c3681d0617f",
"c4dc0bf9-aafc-44b1-acfc-c4454dcf7e27"
],
"Groups": [
"882e96e9-5ee9-428b-a5ea-d97c1f20f874",
"a64701ed-7c1a-459b-93ed-8c3f6538fbff"
],
"Opportunities": [
"47512570-58c2-4856-8947-17bdcdbc5110",
"2b1fae30-bd7d-451a-835a-f1c198f445f8"
]
}
}
]