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": "25f2a335-978b-424e-9d9c-fef7146bd98a",
"SeriesId": "2b35d537-b83b-4e97-85c6-2f4dd9dc8aad",
"AccessorID": "0b5dd6ef-6bae-4a89-a4d7-9fedd4a83fc0",
"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": "b5b8b240-12b8-42e4-aed6-53c1415e600a",
"ScheduledByID": "e272034e-8d9f-45ae-8ff9-43046e5d57ad",
"DeletedDates": [
"2026-10-20T20:02:02Z",
"2026-10-20T20:02:02Z"
],
"ClearedDates": [
"2026-10-20T20:02:02Z",
"2026-10-20T20:02:02Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-20T20:02:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-20T20:02:02Z",
"CreateDate": "2026-10-20T20:02:02Z",
"OccurTime": "2026-10-20T20:02:02Z",
"OccurEndTime": "2026-10-20T20:02:02Z",
"StartTime": "2026-10-20T20:02:02Z",
"EndTime": "2026-10-20T20:02:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d1cbf45-d6e9-4f6c-aede-726f3683b253",
"d2b94bbc-ffe4-409c-a8d9-2b5601958815"
],
"Companies": [
"c1c24fb3-43c3-4c4e-b15e-86c6a185b7fd",
"7626bc38-e65b-4dd6-8470-8e7137fa5487"
],
"Groups": [
"ac9bc408-e5a4-46a3-9160-6001641908bc",
"92aa8dac-735a-4afa-8b64-a1f1a6d51a30"
],
"Opportunities": [
"d3ff31e2-87a4-4231-99a6-7da697764519",
"a75da908-8da3-4d25-b8e7-f0968c1ec889"
]
}
},
{
"Id": "25f2a335-978b-424e-9d9c-fef7146bd98a",
"SeriesId": "2b35d537-b83b-4e97-85c6-2f4dd9dc8aad",
"AccessorID": "0b5dd6ef-6bae-4a89-a4d7-9fedd4a83fc0",
"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": "b5b8b240-12b8-42e4-aed6-53c1415e600a",
"ScheduledByID": "e272034e-8d9f-45ae-8ff9-43046e5d57ad",
"DeletedDates": [
"2026-10-20T20:02:02Z",
"2026-10-20T20:02:02Z"
],
"ClearedDates": [
"2026-10-20T20:02:02Z",
"2026-10-20T20:02:02Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-20T20:02:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-20T20:02:02Z",
"CreateDate": "2026-10-20T20:02:02Z",
"OccurTime": "2026-10-20T20:02:02Z",
"OccurEndTime": "2026-10-20T20:02:02Z",
"StartTime": "2026-10-20T20:02:02Z",
"EndTime": "2026-10-20T20:02:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"9d1cbf45-d6e9-4f6c-aede-726f3683b253",
"d2b94bbc-ffe4-409c-a8d9-2b5601958815"
],
"Companies": [
"c1c24fb3-43c3-4c4e-b15e-86c6a185b7fd",
"7626bc38-e65b-4dd6-8470-8e7137fa5487"
],
"Groups": [
"ac9bc408-e5a4-46a3-9160-6001641908bc",
"92aa8dac-735a-4afa-8b64-a1f1a6d51a30"
],
"Opportunities": [
"d3ff31e2-87a4-4231-99a6-7da697764519",
"a75da908-8da3-4d25-b8e7-f0968c1ec889"
]
}
}
]