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": "ba3b87be-f0d7-4c38-bd33-72253ff74c03",
"SeriesId": "925ac50b-d1c0-4d52-a503-785a28acce28",
"AccessorID": "1099e276-080f-42b7-b099-d809f729ca16",
"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": "2b4d5843-0d06-440e-a3c3-b4b2b9c9f1ac",
"ScheduledByID": "0c60a92b-7279-4fc9-9a6e-a1e7bbad0c56",
"DeletedDates": [
"2026-07-15T02:58:44Z",
"2026-07-15T02:58:44Z"
],
"ClearedDates": [
"2026-07-15T02:58:44Z",
"2026-07-15T02:58:44Z"
],
"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-15T02:58:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-15T02:58:44Z",
"CreateDate": "2026-07-15T02:58:44Z",
"OccurTime": "2026-07-15T02:58:44Z",
"OccurEndTime": "2026-07-15T02:58:44Z",
"StartTime": "2026-07-15T02:58:44Z",
"EndTime": "2026-07-15T02:58:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a5315cc5-c7dd-4f2d-94cb-578d80c94db6",
"01ec053c-0f38-44ba-b18e-86d5f2364466"
],
"Companies": [
"136d2e8d-5cd9-47a4-930c-676489fd307a",
"829bff64-5c5d-4168-a8c1-4fe14fe0b3d4"
],
"Groups": [
"76138137-1616-43f8-b9fd-c71ff9ba8362",
"3cc442b1-e05d-409b-b701-671904497343"
],
"Opportunities": [
"25482832-6db9-4431-898a-f8c72f1025a9",
"82da8d67-b4cb-4696-b5da-e5a489ad6cf9"
]
}
},
{
"Id": "ba3b87be-f0d7-4c38-bd33-72253ff74c03",
"SeriesId": "925ac50b-d1c0-4d52-a503-785a28acce28",
"AccessorID": "1099e276-080f-42b7-b099-d809f729ca16",
"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": "2b4d5843-0d06-440e-a3c3-b4b2b9c9f1ac",
"ScheduledByID": "0c60a92b-7279-4fc9-9a6e-a1e7bbad0c56",
"DeletedDates": [
"2026-07-15T02:58:44Z",
"2026-07-15T02:58:44Z"
],
"ClearedDates": [
"2026-07-15T02:58:44Z",
"2026-07-15T02:58:44Z"
],
"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-15T02:58:44Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-15T02:58:44Z",
"CreateDate": "2026-07-15T02:58:44Z",
"OccurTime": "2026-07-15T02:58:44Z",
"OccurEndTime": "2026-07-15T02:58:44Z",
"StartTime": "2026-07-15T02:58:44Z",
"EndTime": "2026-07-15T02:58:44Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a5315cc5-c7dd-4f2d-94cb-578d80c94db6",
"01ec053c-0f38-44ba-b18e-86d5f2364466"
],
"Companies": [
"136d2e8d-5cd9-47a4-930c-676489fd307a",
"829bff64-5c5d-4168-a8c1-4fe14fe0b3d4"
],
"Groups": [
"76138137-1616-43f8-b9fd-c71ff9ba8362",
"3cc442b1-e05d-409b-b701-671904497343"
],
"Opportunities": [
"25482832-6db9-4431-898a-f8c72f1025a9",
"82da8d67-b4cb-4696-b5da-e5a489ad6cf9"
]
}
}
]