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": "85713d2a-8873-4f0e-8ec6-cfbffa85c39f",
"SeriesId": "f4b0d28b-4d66-4f4e-b6c3-d01b3ed165fd",
"AccessorID": "7df64ba8-5fe3-4d83-9d5e-1a955be19081",
"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": "0c5996b5-0411-454b-8bc3-94ab002de2e3",
"ScheduledByID": "9bd84b93-255e-45b8-b5e3-2189082c1b5c",
"DeletedDates": [
"2026-09-29T12:10:03Z",
"2026-09-29T12:10:03Z"
],
"ClearedDates": [
"2026-09-29T12:10:03Z",
"2026-09-29T12:10:03Z"
],
"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-29T12:10:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-29T12:10:03Z",
"CreateDate": "2026-09-29T12:10:03Z",
"OccurTime": "2026-09-29T12:10:03Z",
"OccurEndTime": "2026-09-29T12:10:03Z",
"StartTime": "2026-09-29T12:10:03Z",
"EndTime": "2026-09-29T12:10:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"48f42a54-3b33-44c4-9da3-84043c1d2fe0",
"66d0c7ea-d6dd-4ec8-b100-486017871003"
],
"Companies": [
"6c49eeeb-bbb8-47ea-8015-e1b68b81c310",
"c4829de5-e4f6-4777-825d-d9a9732bb9e3"
],
"Groups": [
"4c56acdd-1ca3-428a-a180-c6293dc118c8",
"b996b52e-273c-4596-b482-96a25fd5a383"
],
"Opportunities": [
"91411a5f-23f5-404e-a0a4-8f8433956b62",
"03b4dc7d-9cfc-434d-ae41-55012c04bb44"
]
}
},
{
"Id": "85713d2a-8873-4f0e-8ec6-cfbffa85c39f",
"SeriesId": "f4b0d28b-4d66-4f4e-b6c3-d01b3ed165fd",
"AccessorID": "7df64ba8-5fe3-4d83-9d5e-1a955be19081",
"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": "0c5996b5-0411-454b-8bc3-94ab002de2e3",
"ScheduledByID": "9bd84b93-255e-45b8-b5e3-2189082c1b5c",
"DeletedDates": [
"2026-09-29T12:10:03Z",
"2026-09-29T12:10:03Z"
],
"ClearedDates": [
"2026-09-29T12:10:03Z",
"2026-09-29T12:10:03Z"
],
"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-29T12:10:03Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-29T12:10:03Z",
"CreateDate": "2026-09-29T12:10:03Z",
"OccurTime": "2026-09-29T12:10:03Z",
"OccurEndTime": "2026-09-29T12:10:03Z",
"StartTime": "2026-09-29T12:10:03Z",
"EndTime": "2026-09-29T12:10:03Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"48f42a54-3b33-44c4-9da3-84043c1d2fe0",
"66d0c7ea-d6dd-4ec8-b100-486017871003"
],
"Companies": [
"6c49eeeb-bbb8-47ea-8015-e1b68b81c310",
"c4829de5-e4f6-4777-825d-d9a9732bb9e3"
],
"Groups": [
"4c56acdd-1ca3-428a-a180-c6293dc118c8",
"b996b52e-273c-4596-b482-96a25fd5a383"
],
"Opportunities": [
"91411a5f-23f5-404e-a0a4-8f8433956b62",
"03b4dc7d-9cfc-434d-ae41-55012c04bb44"
]
}
}
]