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": "64b5819c-0319-436e-92e4-7f262c332f8b",
"SeriesId": "2b31e177-3eb3-43b5-a831-0bb783b04790",
"AccessorID": "d6e768e8-8c26-44ea-bbeb-b54810d58135",
"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": "e63ce056-5251-4790-8755-5bfaaa9b590f",
"ScheduledByID": "9ff13725-f7a7-4965-883a-a4ef510675f1",
"DeletedDates": [
"2026-05-22T14:01:33Z",
"2026-05-22T14:01:33Z"
],
"ClearedDates": [
"2026-05-22T14:01:33Z",
"2026-05-22T14:01:33Z"
],
"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-22T14:01:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-22T14:01:33Z",
"CreateDate": "2026-05-22T14:01:33Z",
"OccurTime": "2026-05-22T14:01:33Z",
"OccurEndTime": "2026-05-22T14:01:33Z",
"StartTime": "2026-05-22T14:01:33Z",
"EndTime": "2026-05-22T14:01:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"61b1a30a-1f4b-43a0-9833-8c2cc91dac39",
"f090ec4a-c3d1-4d1f-9f33-051da34f1508"
],
"Companies": [
"a9f9686d-0014-4c97-85dd-6bfd99b1f334",
"afc637fb-d3c8-4d56-a640-fecd7feeedf7"
],
"Groups": [
"2d25cf84-6509-4469-87b6-56fce45cac14",
"fce64539-f3da-49d5-bc88-90a0b546a287"
],
"Opportunities": [
"69576c23-c9b9-493a-ada7-a5cc9cc33c27",
"67520d43-a030-46f9-ac14-de3247346c17"
]
}
},
{
"Id": "64b5819c-0319-436e-92e4-7f262c332f8b",
"SeriesId": "2b31e177-3eb3-43b5-a831-0bb783b04790",
"AccessorID": "d6e768e8-8c26-44ea-bbeb-b54810d58135",
"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": "e63ce056-5251-4790-8755-5bfaaa9b590f",
"ScheduledByID": "9ff13725-f7a7-4965-883a-a4ef510675f1",
"DeletedDates": [
"2026-05-22T14:01:33Z",
"2026-05-22T14:01:33Z"
],
"ClearedDates": [
"2026-05-22T14:01:33Z",
"2026-05-22T14:01:33Z"
],
"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-22T14:01:33Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-22T14:01:33Z",
"CreateDate": "2026-05-22T14:01:33Z",
"OccurTime": "2026-05-22T14:01:33Z",
"OccurEndTime": "2026-05-22T14:01:33Z",
"StartTime": "2026-05-22T14:01:33Z",
"EndTime": "2026-05-22T14:01:33Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"61b1a30a-1f4b-43a0-9833-8c2cc91dac39",
"f090ec4a-c3d1-4d1f-9f33-051da34f1508"
],
"Companies": [
"a9f9686d-0014-4c97-85dd-6bfd99b1f334",
"afc637fb-d3c8-4d56-a640-fecd7feeedf7"
],
"Groups": [
"2d25cf84-6509-4469-87b6-56fce45cac14",
"fce64539-f3da-49d5-bc88-90a0b546a287"
],
"Opportunities": [
"69576c23-c9b9-493a-ada7-a5cc9cc33c27",
"67520d43-a030-46f9-ac14-de3247346c17"
]
}
}
]