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": "65c35759-94d7-4bfa-b095-ed95f8a08b8e",
"SeriesId": "8b8e8f03-a841-4d5e-abba-e8e20a7d88c2",
"AccessorID": "f5b13b8d-2193-4f63-a09f-bf3664372dff",
"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": "0bacdf1f-ea5d-4e06-9eab-d0a0a218e1ed",
"ScheduledByID": "b2171b59-ab20-4a94-9b42-b97cfb7431e0",
"DeletedDates": [
"2026-09-13T10:38:20Z",
"2026-09-13T10:38:20Z"
],
"ClearedDates": [
"2026-09-13T10:38:20Z",
"2026-09-13T10:38:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-13T10:38:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-13T10:38:20Z",
"CreateDate": "2026-09-13T10:38:20Z",
"OccurTime": "2026-09-13T10:38:20Z",
"OccurEndTime": "2026-09-13T10:38:20Z",
"StartTime": "2026-09-13T10:38:20Z",
"EndTime": "2026-09-13T10:38:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ae784c1f-a0f4-464e-9b19-71ada7d8d518",
"182db9ed-90d0-40d5-b232-512a1273b1fa"
],
"Companies": [
"d3d005d8-79b2-4c62-bd5d-8759aff9e177",
"ed8d9ce8-3def-40c8-81b6-18f7b4401879"
],
"Groups": [
"1baaf1ff-5e2f-4b90-aa1c-bcd0b4bc02e7",
"e94f76ad-5957-4136-95d4-188ad62f1f38"
],
"Opportunities": [
"497780f1-8d55-4246-9890-0bceb2105aca",
"a1f36de7-fe72-480b-a89a-1553f6a9f572"
]
}
},
{
"Id": "65c35759-94d7-4bfa-b095-ed95f8a08b8e",
"SeriesId": "8b8e8f03-a841-4d5e-abba-e8e20a7d88c2",
"AccessorID": "f5b13b8d-2193-4f63-a09f-bf3664372dff",
"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": "0bacdf1f-ea5d-4e06-9eab-d0a0a218e1ed",
"ScheduledByID": "b2171b59-ab20-4a94-9b42-b97cfb7431e0",
"DeletedDates": [
"2026-09-13T10:38:20Z",
"2026-09-13T10:38:20Z"
],
"ClearedDates": [
"2026-09-13T10:38:20Z",
"2026-09-13T10:38:20Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-09-13T10:38:20Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-13T10:38:20Z",
"CreateDate": "2026-09-13T10:38:20Z",
"OccurTime": "2026-09-13T10:38:20Z",
"OccurEndTime": "2026-09-13T10:38:20Z",
"StartTime": "2026-09-13T10:38:20Z",
"EndTime": "2026-09-13T10:38:20Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"ae784c1f-a0f4-464e-9b19-71ada7d8d518",
"182db9ed-90d0-40d5-b232-512a1273b1fa"
],
"Companies": [
"d3d005d8-79b2-4c62-bd5d-8759aff9e177",
"ed8d9ce8-3def-40c8-81b6-18f7b4401879"
],
"Groups": [
"1baaf1ff-5e2f-4b90-aa1c-bcd0b4bc02e7",
"e94f76ad-5957-4136-95d4-188ad62f1f38"
],
"Opportunities": [
"497780f1-8d55-4246-9890-0bceb2105aca",
"a1f36de7-fe72-480b-a89a-1553f6a9f572"
]
}
}
]