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": "73de93dc-28cc-4720-8aad-72cecf8efd02",
"SeriesId": "6b2afeae-7c1b-413a-a835-de7d074da226",
"AccessorID": "43288569-069b-4c71-9f24-6b2d9eb0dce7",
"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": "623180d4-6954-4542-a9aa-c8b7b9d8b9d7",
"ScheduledByID": "258eb1ea-0246-4cb8-ba5b-96b778f8be5f",
"DeletedDates": [
"2026-04-29T07:46:26Z",
"2026-04-29T07:46:26Z"
],
"ClearedDates": [
"2026-04-29T07:46:26Z",
"2026-04-29T07:46: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-04-29T07:46:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-29T07:46:26Z",
"CreateDate": "2026-04-29T07:46:26Z",
"OccurTime": "2026-04-29T07:46:26Z",
"OccurEndTime": "2026-04-29T07:46:26Z",
"StartTime": "2026-04-29T07:46:26Z",
"EndTime": "2026-04-29T07:46:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2af347c0-fbdb-4598-9a8a-fa42b9ec9bc1",
"339c325b-d829-47a9-b63f-7fd7a5ddbee2"
],
"Companies": [
"d838128b-0e5a-414d-9ce8-b509067367d8",
"a02df142-7254-4177-85db-cefd07d1f521"
],
"Groups": [
"eb36a537-a860-4124-9e79-e1bff7003203",
"db9b920c-c4b0-4110-978a-8ae51a546d0e"
],
"Opportunities": [
"5134f6bc-2e70-47d8-ba60-c1ec1ea26fc5",
"a459376f-1030-4d6f-a5b4-320025594d6f"
]
}
},
{
"Id": "73de93dc-28cc-4720-8aad-72cecf8efd02",
"SeriesId": "6b2afeae-7c1b-413a-a835-de7d074da226",
"AccessorID": "43288569-069b-4c71-9f24-6b2d9eb0dce7",
"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": "623180d4-6954-4542-a9aa-c8b7b9d8b9d7",
"ScheduledByID": "258eb1ea-0246-4cb8-ba5b-96b778f8be5f",
"DeletedDates": [
"2026-04-29T07:46:26Z",
"2026-04-29T07:46:26Z"
],
"ClearedDates": [
"2026-04-29T07:46:26Z",
"2026-04-29T07:46: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-04-29T07:46:26Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-04-29T07:46:26Z",
"CreateDate": "2026-04-29T07:46:26Z",
"OccurTime": "2026-04-29T07:46:26Z",
"OccurEndTime": "2026-04-29T07:46:26Z",
"StartTime": "2026-04-29T07:46:26Z",
"EndTime": "2026-04-29T07:46:26Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2af347c0-fbdb-4598-9a8a-fa42b9ec9bc1",
"339c325b-d829-47a9-b63f-7fd7a5ddbee2"
],
"Companies": [
"d838128b-0e5a-414d-9ce8-b509067367d8",
"a02df142-7254-4177-85db-cefd07d1f521"
],
"Groups": [
"eb36a537-a860-4124-9e79-e1bff7003203",
"db9b920c-c4b0-4110-978a-8ae51a546d0e"
],
"Opportunities": [
"5134f6bc-2e70-47d8-ba60-c1ec1ea26fc5",
"a459376f-1030-4d6f-a5b4-320025594d6f"
]
}
}
]