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": "ea7299f9-dd5e-48dd-8c36-7577d5c70348",
"SeriesId": "76988b02-68b9-4c00-a99b-6f74ce279c20",
"AccessorID": "9b0f42d6-dc4c-41b7-a306-cceccef45afc",
"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": "4ced5a18-972e-43a9-a79b-5e86306297b9",
"ScheduledByID": "ca7100fe-d4a1-4c5c-a054-22e42e7fc7c8",
"DeletedDates": [
"2026-10-17T10:00:09Z",
"2026-10-17T10:00:09Z"
],
"ClearedDates": [
"2026-10-17T10:00:09Z",
"2026-10-17T10:00:09Z"
],
"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-17T10:00:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-17T10:00:09Z",
"CreateDate": "2026-10-17T10:00:09Z",
"OccurTime": "2026-10-17T10:00:09Z",
"OccurEndTime": "2026-10-17T10:00:09Z",
"StartTime": "2026-10-17T10:00:09Z",
"EndTime": "2026-10-17T10:00:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"faa56a81-19f0-477f-a502-1a98496f7f3a",
"d555eeac-e336-4007-8cdf-149a6a72b7fd"
],
"Companies": [
"d846b619-e066-4a9d-8b42-0c9f9b02fac6",
"a80d5d78-53cf-4dae-83ed-f02bc2337905"
],
"Groups": [
"a38f1ada-40ea-488e-aa47-6eb7d28a8f7f",
"4b58e06d-f562-407b-bc8b-694bdce10568"
],
"Opportunities": [
"5e48b1e0-f7d6-48bc-a2d4-b5f04523a3e9",
"0e59e9d4-5262-4f0a-9c35-6a1d1c495853"
]
}
},
{
"Id": "ea7299f9-dd5e-48dd-8c36-7577d5c70348",
"SeriesId": "76988b02-68b9-4c00-a99b-6f74ce279c20",
"AccessorID": "9b0f42d6-dc4c-41b7-a306-cceccef45afc",
"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": "4ced5a18-972e-43a9-a79b-5e86306297b9",
"ScheduledByID": "ca7100fe-d4a1-4c5c-a054-22e42e7fc7c8",
"DeletedDates": [
"2026-10-17T10:00:09Z",
"2026-10-17T10:00:09Z"
],
"ClearedDates": [
"2026-10-17T10:00:09Z",
"2026-10-17T10:00:09Z"
],
"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-17T10:00:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-17T10:00:09Z",
"CreateDate": "2026-10-17T10:00:09Z",
"OccurTime": "2026-10-17T10:00:09Z",
"OccurEndTime": "2026-10-17T10:00:09Z",
"StartTime": "2026-10-17T10:00:09Z",
"EndTime": "2026-10-17T10:00:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"faa56a81-19f0-477f-a502-1a98496f7f3a",
"d555eeac-e336-4007-8cdf-149a6a72b7fd"
],
"Companies": [
"d846b619-e066-4a9d-8b42-0c9f9b02fac6",
"a80d5d78-53cf-4dae-83ed-f02bc2337905"
],
"Groups": [
"a38f1ada-40ea-488e-aa47-6eb7d28a8f7f",
"4b58e06d-f562-407b-bc8b-694bdce10568"
],
"Opportunities": [
"5e48b1e0-f7d6-48bc-a2d4-b5f04523a3e9",
"0e59e9d4-5262-4f0a-9c35-6a1d1c495853"
]
}
}
]