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": "5ae8f8e9-d7bb-48c3-92d7-9d946228da35",
"SeriesId": "feb36b7b-9f31-44f5-bc7f-1ba336ffe54d",
"AccessorID": "66e843d2-5b95-4bb6-8796-236e51b91fe7",
"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": "b9749b00-0fa3-4409-8de1-0648f5080c37",
"ScheduledByID": "9c194a68-c1a7-4b86-801b-f7de93912e3d",
"DeletedDates": [
"2026-07-02T16:54:57Z",
"2026-07-02T16:54:57Z"
],
"ClearedDates": [
"2026-07-02T16:54:57Z",
"2026-07-02T16:54:57Z"
],
"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-02T16:54:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-02T16:54:57Z",
"CreateDate": "2026-07-02T16:54:57Z",
"OccurTime": "2026-07-02T16:54:57Z",
"OccurEndTime": "2026-07-02T16:54:57Z",
"StartTime": "2026-07-02T16:54:57Z",
"EndTime": "2026-07-02T16:54:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ee110452-97c9-45f0-b331-6def5f01246f",
"d0b5a1ce-61d4-4850-bb03-66cdcfaced68"
],
"Companies": [
"96319ecc-4e6a-49f8-91ee-9b7cd9b7a747",
"bd110624-24eb-43ab-8652-642375f1b051"
],
"Groups": [
"898a34ce-bf34-40d1-954b-6f83a06ce821",
"92090173-f9e0-4239-9f61-91a2d417b4b8"
],
"Opportunities": [
"fc35d5d8-7b1b-46b9-a90c-955c4da46f4e",
"516ffe5f-cb13-4cd5-b6b5-353e762a6b3b"
]
}
},
{
"Id": "5ae8f8e9-d7bb-48c3-92d7-9d946228da35",
"SeriesId": "feb36b7b-9f31-44f5-bc7f-1ba336ffe54d",
"AccessorID": "66e843d2-5b95-4bb6-8796-236e51b91fe7",
"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": "b9749b00-0fa3-4409-8de1-0648f5080c37",
"ScheduledByID": "9c194a68-c1a7-4b86-801b-f7de93912e3d",
"DeletedDates": [
"2026-07-02T16:54:57Z",
"2026-07-02T16:54:57Z"
],
"ClearedDates": [
"2026-07-02T16:54:57Z",
"2026-07-02T16:54:57Z"
],
"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-02T16:54:57Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-02T16:54:57Z",
"CreateDate": "2026-07-02T16:54:57Z",
"OccurTime": "2026-07-02T16:54:57Z",
"OccurEndTime": "2026-07-02T16:54:57Z",
"StartTime": "2026-07-02T16:54:57Z",
"EndTime": "2026-07-02T16:54:57Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ee110452-97c9-45f0-b331-6def5f01246f",
"d0b5a1ce-61d4-4850-bb03-66cdcfaced68"
],
"Companies": [
"96319ecc-4e6a-49f8-91ee-9b7cd9b7a747",
"bd110624-24eb-43ab-8652-642375f1b051"
],
"Groups": [
"898a34ce-bf34-40d1-954b-6f83a06ce821",
"92090173-f9e0-4239-9f61-91a2d417b4b8"
],
"Opportunities": [
"fc35d5d8-7b1b-46b9-a90c-955c4da46f4e",
"516ffe5f-cb13-4cd5-b6b5-353e762a6b3b"
]
}
}
]