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": "28564eab-a99b-4290-832f-eaa19ffc0e86",
"SeriesId": "8fc6f961-ed28-40db-b97b-847e2eb0c7ce",
"AccessorID": "27ed7385-c550-4949-a0ee-33b1ba73d406",
"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": "faf2ac3d-41f3-4db3-898e-e511441f3ca4",
"ScheduledByID": "899db277-b1fc-4978-9234-e0ff0f460442",
"DeletedDates": [
"2026-07-18T04:54:26Z",
"2026-07-18T04:54:26Z"
],
"ClearedDates": [
"2026-07-18T04:54:26Z",
"2026-07-18T04:54:26Z"
],
"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-18T04:54:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-18T04:54:26Z",
"CreateDate": "2026-07-18T04:54:26Z",
"OccurTime": "2026-07-18T04:54:26Z",
"OccurEndTime": "2026-07-18T04:54:26Z",
"StartTime": "2026-07-18T04:54:26Z",
"EndTime": "2026-07-18T04:54:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7553ee44-6085-4973-9396-567a934e6d99",
"8ddce6bc-9386-4f0f-acae-ec2f8e134b0d"
],
"Companies": [
"87b85df2-009b-446b-a58f-fc7bf2fb3623",
"ab967ed4-d01a-41cd-93c7-fbca9ff3ad73"
],
"Groups": [
"597df067-e349-4fd9-956f-d45c7c3a90d2",
"208e30a1-ffd1-45ec-851a-8b36423c8e1b"
],
"Opportunities": [
"260b9584-83c3-4a14-bdf5-3567f416b663",
"f6461861-44e9-40a2-bf09-a07e7d87a22e"
]
}
},
{
"Id": "28564eab-a99b-4290-832f-eaa19ffc0e86",
"SeriesId": "8fc6f961-ed28-40db-b97b-847e2eb0c7ce",
"AccessorID": "27ed7385-c550-4949-a0ee-33b1ba73d406",
"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": "faf2ac3d-41f3-4db3-898e-e511441f3ca4",
"ScheduledByID": "899db277-b1fc-4978-9234-e0ff0f460442",
"DeletedDates": [
"2026-07-18T04:54:26Z",
"2026-07-18T04:54:26Z"
],
"ClearedDates": [
"2026-07-18T04:54:26Z",
"2026-07-18T04:54:26Z"
],
"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-18T04:54:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-18T04:54:26Z",
"CreateDate": "2026-07-18T04:54:26Z",
"OccurTime": "2026-07-18T04:54:26Z",
"OccurEndTime": "2026-07-18T04:54:26Z",
"StartTime": "2026-07-18T04:54:26Z",
"EndTime": "2026-07-18T04:54:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7553ee44-6085-4973-9396-567a934e6d99",
"8ddce6bc-9386-4f0f-acae-ec2f8e134b0d"
],
"Companies": [
"87b85df2-009b-446b-a58f-fc7bf2fb3623",
"ab967ed4-d01a-41cd-93c7-fbca9ff3ad73"
],
"Groups": [
"597df067-e349-4fd9-956f-d45c7c3a90d2",
"208e30a1-ffd1-45ec-851a-8b36423c8e1b"
],
"Opportunities": [
"260b9584-83c3-4a14-bdf5-3567f416b663",
"f6461861-44e9-40a2-bf09-a07e7d87a22e"
]
}
}
]