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": "cacab236-10e9-4ceb-a134-e16a3de3db39",
"SeriesId": "fa84bb09-7dae-478b-bcca-bc666774e5ec",
"AccessorID": "5f9ca911-ae12-4100-810a-a1b41b5ba33d",
"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": "8fb09f50-19cb-4208-b20a-39b63220b437",
"ScheduledByID": "6311ebb8-721f-4b69-a6ce-fb6aedb4c3c7",
"DeletedDates": [
"2026-11-12T13:08:36Z",
"2026-11-12T13:08:36Z"
],
"ClearedDates": [
"2026-11-12T13:08:36Z",
"2026-11-12T13:08:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-12T13:08:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-12T13:08:36Z",
"CreateDate": "2026-11-12T13:08:36Z",
"OccurTime": "2026-11-12T13:08:36Z",
"OccurEndTime": "2026-11-12T13:08:36Z",
"StartTime": "2026-11-12T13:08:36Z",
"EndTime": "2026-11-12T13:08:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"49a79c1b-33dd-42c4-88bf-462b276edf09",
"0030e23b-79dc-4e13-a4db-265a2828ae94"
],
"Companies": [
"d1c8fa09-b9cb-4520-95fc-41a1b84a713f",
"4d6cb176-b247-45d0-8635-fd7a7b15f7b8"
],
"Groups": [
"95cef5de-dc41-4406-b651-55e34ec25ef0",
"c229ea1c-086c-4b4b-81db-a539e2135d0c"
],
"Opportunities": [
"fe348cf6-1831-4b87-8c22-d88e018aa40e",
"0700f6be-9198-4a0d-95b2-a980e3788e5b"
]
}
},
{
"Id": "cacab236-10e9-4ceb-a134-e16a3de3db39",
"SeriesId": "fa84bb09-7dae-478b-bcca-bc666774e5ec",
"AccessorID": "5f9ca911-ae12-4100-810a-a1b41b5ba33d",
"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": "8fb09f50-19cb-4208-b20a-39b63220b437",
"ScheduledByID": "6311ebb8-721f-4b69-a6ce-fb6aedb4c3c7",
"DeletedDates": [
"2026-11-12T13:08:36Z",
"2026-11-12T13:08:36Z"
],
"ClearedDates": [
"2026-11-12T13:08:36Z",
"2026-11-12T13:08:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-12T13:08:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-12T13:08:36Z",
"CreateDate": "2026-11-12T13:08:36Z",
"OccurTime": "2026-11-12T13:08:36Z",
"OccurEndTime": "2026-11-12T13:08:36Z",
"StartTime": "2026-11-12T13:08:36Z",
"EndTime": "2026-11-12T13:08:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"49a79c1b-33dd-42c4-88bf-462b276edf09",
"0030e23b-79dc-4e13-a4db-265a2828ae94"
],
"Companies": [
"d1c8fa09-b9cb-4520-95fc-41a1b84a713f",
"4d6cb176-b247-45d0-8635-fd7a7b15f7b8"
],
"Groups": [
"95cef5de-dc41-4406-b651-55e34ec25ef0",
"c229ea1c-086c-4b4b-81db-a539e2135d0c"
],
"Opportunities": [
"fe348cf6-1831-4b87-8c22-d88e018aa40e",
"0700f6be-9198-4a0d-95b2-a980e3788e5b"
]
}
}
]