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": "eb9fd9cd-a6d7-4c82-b7ab-df054944253e",
"SeriesId": "dce094a1-25cf-4feb-8682-f60a1f021a2b",
"AccessorID": "67170968-c7bc-49b2-8c85-0ff5861178d3",
"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": "e5428d5b-b9d2-496a-b11c-82c6bbe3260d",
"ScheduledByID": "a92f5081-11ff-482d-b27d-3f6d4dc70af2",
"DeletedDates": [
"2026-04-30T08:07:21Z",
"2026-04-30T08:07:21Z"
],
"ClearedDates": [
"2026-04-30T08:07:21Z",
"2026-04-30T08:07:21Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-30T08:07:21Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-30T08:07:21Z",
"CreateDate": "2026-04-30T08:07:21Z",
"OccurTime": "2026-04-30T08:07:21Z",
"OccurEndTime": "2026-04-30T08:07:21Z",
"StartTime": "2026-04-30T08:07:21Z",
"EndTime": "2026-04-30T08:07:21Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18fa4812-fcf0-4de3-bdb7-a127c47d0200",
"1cbfcb81-76de-4f61-af2c-2925ac7b5a38"
],
"Companies": [
"051f36f1-8e0b-4c2f-82f9-b171272e4bfc",
"021fb13a-a651-4919-88ca-54bc83c5308b"
],
"Groups": [
"c6f27121-bd50-49de-bfef-2849f4d81499",
"50c3e497-dc2e-4167-90a7-8d0924f82591"
],
"Opportunities": [
"4b7e1ce3-8351-4bdd-b117-90855dd6733c",
"67948baf-4cac-4324-a600-9241db5e251b"
]
}
},
{
"Id": "eb9fd9cd-a6d7-4c82-b7ab-df054944253e",
"SeriesId": "dce094a1-25cf-4feb-8682-f60a1f021a2b",
"AccessorID": "67170968-c7bc-49b2-8c85-0ff5861178d3",
"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": "e5428d5b-b9d2-496a-b11c-82c6bbe3260d",
"ScheduledByID": "a92f5081-11ff-482d-b27d-3f6d4dc70af2",
"DeletedDates": [
"2026-04-30T08:07:21Z",
"2026-04-30T08:07:21Z"
],
"ClearedDates": [
"2026-04-30T08:07:21Z",
"2026-04-30T08:07:21Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-04-30T08:07:21Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-30T08:07:21Z",
"CreateDate": "2026-04-30T08:07:21Z",
"OccurTime": "2026-04-30T08:07:21Z",
"OccurEndTime": "2026-04-30T08:07:21Z",
"StartTime": "2026-04-30T08:07:21Z",
"EndTime": "2026-04-30T08:07:21Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"18fa4812-fcf0-4de3-bdb7-a127c47d0200",
"1cbfcb81-76de-4f61-af2c-2925ac7b5a38"
],
"Companies": [
"051f36f1-8e0b-4c2f-82f9-b171272e4bfc",
"021fb13a-a651-4919-88ca-54bc83c5308b"
],
"Groups": [
"c6f27121-bd50-49de-bfef-2849f4d81499",
"50c3e497-dc2e-4167-90a7-8d0924f82591"
],
"Opportunities": [
"4b7e1ce3-8351-4bdd-b117-90855dd6733c",
"67948baf-4cac-4324-a600-9241db5e251b"
]
}
}
]