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": "414e3883-a610-462a-b825-9477d0c08675",
"SeriesId": "d8f6ea11-d062-4403-a2f2-a262c50a2bde",
"AccessorID": "48f33fdf-7491-4220-ac5f-fa629c32cfde",
"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": "40d663cc-c5c5-4ebc-941e-3d9abcf72557",
"ScheduledByID": "aee47b72-fd5b-461f-bd54-7da9e5f0a543",
"DeletedDates": [
"2026-08-10T19:55:56Z",
"2026-08-10T19:55:56Z"
],
"ClearedDates": [
"2026-08-10T19:55:56Z",
"2026-08-10T19:55:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-10T19:55:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-10T19:55:56Z",
"CreateDate": "2026-08-10T19:55:56Z",
"OccurTime": "2026-08-10T19:55:56Z",
"OccurEndTime": "2026-08-10T19:55:56Z",
"StartTime": "2026-08-10T19:55:56Z",
"EndTime": "2026-08-10T19:55:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a7afcabb-167d-448c-8416-2005b4370451",
"da82b7e1-9068-4e8f-84a8-d6406b639d8b"
],
"Companies": [
"50ce104b-8513-48f0-948d-ab755c1c3cfd",
"4f0ca773-0004-4588-809c-958bebc1baa5"
],
"Groups": [
"156b2d81-de97-4c18-832b-e8cdf0f248ac",
"5e19bde4-28a6-4955-a5bd-f62ad39c0f2d"
],
"Opportunities": [
"b5b9d2b9-f23b-4c99-bc38-a96049e77992",
"ff678163-04af-4e03-a8da-4a63e7c5905f"
]
}
},
{
"Id": "414e3883-a610-462a-b825-9477d0c08675",
"SeriesId": "d8f6ea11-d062-4403-a2f2-a262c50a2bde",
"AccessorID": "48f33fdf-7491-4220-ac5f-fa629c32cfde",
"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": "40d663cc-c5c5-4ebc-941e-3d9abcf72557",
"ScheduledByID": "aee47b72-fd5b-461f-bd54-7da9e5f0a543",
"DeletedDates": [
"2026-08-10T19:55:56Z",
"2026-08-10T19:55:56Z"
],
"ClearedDates": [
"2026-08-10T19:55:56Z",
"2026-08-10T19:55:56Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-08-10T19:55:56Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-10T19:55:56Z",
"CreateDate": "2026-08-10T19:55:56Z",
"OccurTime": "2026-08-10T19:55:56Z",
"OccurEndTime": "2026-08-10T19:55:56Z",
"StartTime": "2026-08-10T19:55:56Z",
"EndTime": "2026-08-10T19:55:56Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"a7afcabb-167d-448c-8416-2005b4370451",
"da82b7e1-9068-4e8f-84a8-d6406b639d8b"
],
"Companies": [
"50ce104b-8513-48f0-948d-ab755c1c3cfd",
"4f0ca773-0004-4588-809c-958bebc1baa5"
],
"Groups": [
"156b2d81-de97-4c18-832b-e8cdf0f248ac",
"5e19bde4-28a6-4955-a5bd-f62ad39c0f2d"
],
"Opportunities": [
"b5b9d2b9-f23b-4c99-bc38-a96049e77992",
"ff678163-04af-4e03-a8da-4a63e7c5905f"
]
}
}
]