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": "ab81a948-486a-4c1a-935d-63d7a9e7ad54",
"SeriesId": "850624c0-8ab5-4d31-a179-258cc64a01c2",
"AccessorID": "7a645dc3-d20f-41b3-bff0-592bcb3496d1",
"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": "7c1765d6-a7de-41f2-9b98-f4ff4c0285bd",
"ScheduledByID": "2de5f2b5-15d5-4b12-98c9-67211bc722cc",
"DeletedDates": [
"2026-06-13T21:30:36Z",
"2026-06-13T21:30:36Z"
],
"ClearedDates": [
"2026-06-13T21:30:36Z",
"2026-06-13T21:30:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-13T21:30:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-13T21:30:36Z",
"CreateDate": "2026-06-13T21:30:36Z",
"OccurTime": "2026-06-13T21:30:36Z",
"OccurEndTime": "2026-06-13T21:30:36Z",
"StartTime": "2026-06-13T21:30:36Z",
"EndTime": "2026-06-13T21:30:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"63f36177-e846-4d6e-a000-5af930213240",
"89bfbcae-eab0-4860-9e8b-b79ccecf8e73"
],
"Companies": [
"bd5ce70f-c007-4b76-8a9f-ef2371643eea",
"bc1d8720-b390-46b7-b483-6fc78c8c69a8"
],
"Groups": [
"2df054a4-e639-4729-852d-06435821159c",
"662f656b-a9d8-45d8-a404-23cc22ae4bda"
],
"Opportunities": [
"ea975043-bea8-40c8-9fee-cdd9998bceec",
"45058ab0-3a13-4294-9cbc-db7f4d43e761"
]
}
},
{
"Id": "ab81a948-486a-4c1a-935d-63d7a9e7ad54",
"SeriesId": "850624c0-8ab5-4d31-a179-258cc64a01c2",
"AccessorID": "7a645dc3-d20f-41b3-bff0-592bcb3496d1",
"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": "7c1765d6-a7de-41f2-9b98-f4ff4c0285bd",
"ScheduledByID": "2de5f2b5-15d5-4b12-98c9-67211bc722cc",
"DeletedDates": [
"2026-06-13T21:30:36Z",
"2026-06-13T21:30:36Z"
],
"ClearedDates": [
"2026-06-13T21:30:36Z",
"2026-06-13T21:30:36Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-13T21:30:36Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-13T21:30:36Z",
"CreateDate": "2026-06-13T21:30:36Z",
"OccurTime": "2026-06-13T21:30:36Z",
"OccurEndTime": "2026-06-13T21:30:36Z",
"StartTime": "2026-06-13T21:30:36Z",
"EndTime": "2026-06-13T21:30:36Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"63f36177-e846-4d6e-a000-5af930213240",
"89bfbcae-eab0-4860-9e8b-b79ccecf8e73"
],
"Companies": [
"bd5ce70f-c007-4b76-8a9f-ef2371643eea",
"bc1d8720-b390-46b7-b483-6fc78c8c69a8"
],
"Groups": [
"2df054a4-e639-4729-852d-06435821159c",
"662f656b-a9d8-45d8-a404-23cc22ae4bda"
],
"Opportunities": [
"ea975043-bea8-40c8-9fee-cdd9998bceec",
"45058ab0-3a13-4294-9cbc-db7f4d43e761"
]
}
}
]