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": "c6a6251a-2395-4c3c-877b-1437be0e83e3",
"SeriesId": "89a86c18-2809-4e8d-a213-5c7ca43ce3e8",
"AccessorID": "0c394dc6-9a9f-4858-84da-4bc0521c3965",
"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": "30a04810-ceb4-4d47-9a03-b7accd4b6e9d",
"ScheduledByID": "c71203c4-5676-4141-b225-d4fa8bbf752b",
"DeletedDates": [
"2026-05-15T12:36:18Z",
"2026-05-15T12:36:18Z"
],
"ClearedDates": [
"2026-05-15T12:36:18Z",
"2026-05-15T12:36:18Z"
],
"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-15T12:36:18Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-15T12:36:18Z",
"CreateDate": "2026-05-15T12:36:18Z",
"OccurTime": "2026-05-15T12:36:18Z",
"OccurEndTime": "2026-05-15T12:36:18Z",
"StartTime": "2026-05-15T12:36:18Z",
"EndTime": "2026-05-15T12:36:18Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e7cb55ee-7a99-480c-867b-c4fa1ad3e61e",
"612f06cd-a8e2-4caf-954a-21672bd18ba3"
],
"Companies": [
"d93f6212-8a0f-41c5-a900-3a6453240b80",
"338a3dc2-b72e-4903-b14e-105bb2c61164"
],
"Groups": [
"7e7361de-9456-497a-bba4-965781c28c3d",
"59005114-f811-40aa-9254-f671d65c9c32"
],
"Opportunities": [
"9d4c3c6e-4b13-4ba4-80e3-020deb057354",
"dac2acb0-6e5b-4538-ab11-2ee1c27cc411"
]
}
},
{
"Id": "c6a6251a-2395-4c3c-877b-1437be0e83e3",
"SeriesId": "89a86c18-2809-4e8d-a213-5c7ca43ce3e8",
"AccessorID": "0c394dc6-9a9f-4858-84da-4bc0521c3965",
"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": "30a04810-ceb4-4d47-9a03-b7accd4b6e9d",
"ScheduledByID": "c71203c4-5676-4141-b225-d4fa8bbf752b",
"DeletedDates": [
"2026-05-15T12:36:18Z",
"2026-05-15T12:36:18Z"
],
"ClearedDates": [
"2026-05-15T12:36:18Z",
"2026-05-15T12:36:18Z"
],
"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-15T12:36:18Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-05-15T12:36:18Z",
"CreateDate": "2026-05-15T12:36:18Z",
"OccurTime": "2026-05-15T12:36:18Z",
"OccurEndTime": "2026-05-15T12:36:18Z",
"StartTime": "2026-05-15T12:36:18Z",
"EndTime": "2026-05-15T12:36:18Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"e7cb55ee-7a99-480c-867b-c4fa1ad3e61e",
"612f06cd-a8e2-4caf-954a-21672bd18ba3"
],
"Companies": [
"d93f6212-8a0f-41c5-a900-3a6453240b80",
"338a3dc2-b72e-4903-b14e-105bb2c61164"
],
"Groups": [
"7e7361de-9456-497a-bba4-965781c28c3d",
"59005114-f811-40aa-9254-f671d65c9c32"
],
"Opportunities": [
"9d4c3c6e-4b13-4ba4-80e3-020deb057354",
"dac2acb0-6e5b-4538-ab11-2ee1c27cc411"
]
}
}
]