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": "d6aa0e1d-eb69-417c-86db-7490310aa4ff",
"SeriesId": "2f669f80-40c2-424b-be90-f6a72f821384",
"AccessorID": "5f7e607d-4366-4c54-8f57-e37a566c4b67",
"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": "16c18fce-5d17-4fab-ae8f-2ba9115c9660",
"ScheduledByID": "a5dce6df-87c8-4a45-a715-7cb9833e7453",
"DeletedDates": [
"2026-07-13T07:04:02Z",
"2026-07-13T07:04:02Z"
],
"ClearedDates": [
"2026-07-13T07:04:02Z",
"2026-07-13T07:04: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-07-13T07:04:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-13T07:04:02Z",
"CreateDate": "2026-07-13T07:04:02Z",
"OccurTime": "2026-07-13T07:04:02Z",
"OccurEndTime": "2026-07-13T07:04:02Z",
"StartTime": "2026-07-13T07:04:02Z",
"EndTime": "2026-07-13T07:04:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"13ff9459-bae7-4387-9d5b-ed0dee5f77c9",
"cf448b34-2159-4821-9ac6-1d609850e0ff"
],
"Companies": [
"893df181-4f6e-487a-a88a-5c52956b53d5",
"2079925e-1466-4142-8fa5-7f31f84ab386"
],
"Groups": [
"4c98cdb0-ca01-40c3-b8b5-7ecfab5c8457",
"7232deb3-1451-463a-9347-4f8d17d8fb2d"
],
"Opportunities": [
"f9a407f7-b875-4af9-9548-7a0302f6408c",
"a5966c5d-b6ec-40c5-9960-2a021115e462"
]
}
},
{
"Id": "d6aa0e1d-eb69-417c-86db-7490310aa4ff",
"SeriesId": "2f669f80-40c2-424b-be90-f6a72f821384",
"AccessorID": "5f7e607d-4366-4c54-8f57-e37a566c4b67",
"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": "16c18fce-5d17-4fab-ae8f-2ba9115c9660",
"ScheduledByID": "a5dce6df-87c8-4a45-a715-7cb9833e7453",
"DeletedDates": [
"2026-07-13T07:04:02Z",
"2026-07-13T07:04:02Z"
],
"ClearedDates": [
"2026-07-13T07:04:02Z",
"2026-07-13T07:04: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-07-13T07:04:02Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-13T07:04:02Z",
"CreateDate": "2026-07-13T07:04:02Z",
"OccurTime": "2026-07-13T07:04:02Z",
"OccurEndTime": "2026-07-13T07:04:02Z",
"StartTime": "2026-07-13T07:04:02Z",
"EndTime": "2026-07-13T07:04:02Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"13ff9459-bae7-4387-9d5b-ed0dee5f77c9",
"cf448b34-2159-4821-9ac6-1d609850e0ff"
],
"Companies": [
"893df181-4f6e-487a-a88a-5c52956b53d5",
"2079925e-1466-4142-8fa5-7f31f84ab386"
],
"Groups": [
"4c98cdb0-ca01-40c3-b8b5-7ecfab5c8457",
"7232deb3-1451-463a-9347-4f8d17d8fb2d"
],
"Opportunities": [
"f9a407f7-b875-4af9-9548-7a0302f6408c",
"a5966c5d-b6ec-40c5-9960-2a021115e462"
]
}
}
]