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": "814ff38c-ee38-48bd-8245-a8107dc10af3",
"SeriesId": "351ef5ee-4e67-49df-a08e-c03f848c89dc",
"AccessorID": "4ed122ff-882d-44c4-b58a-3fb34be92ac2",
"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": "e6ec3e63-8f71-4db0-b471-3eeaedf23255",
"ScheduledByID": "b863600e-98ca-4f21-8070-fddcfd34bc3d",
"DeletedDates": [
"2026-08-10T01:49:51Z",
"2026-08-10T01:49:51Z"
],
"ClearedDates": [
"2026-08-10T01:49:51Z",
"2026-08-10T01:49:51Z"
],
"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-10T01:49:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-10T01:49:51Z",
"CreateDate": "2026-08-10T01:49:51Z",
"OccurTime": "2026-08-10T01:49:51Z",
"OccurEndTime": "2026-08-10T01:49:51Z",
"StartTime": "2026-08-10T01:49:51Z",
"EndTime": "2026-08-10T01:49:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2b843730-e8fd-4590-aa2e-5cd7fe4df61c",
"697c9b02-c45f-44ca-973c-e1946f6dd9c5"
],
"Companies": [
"6b722965-a15c-4d4e-9047-112685ab6ea4",
"3c86d1c1-eee3-48c6-96c5-2058622bed3a"
],
"Groups": [
"7af01e55-0375-4267-94a1-0ad7a4153385",
"2ae90cf2-c70a-467e-862d-f95d5407ff16"
],
"Opportunities": [
"0d13c3b6-6fdf-463f-944c-51ed1ba63d7b",
"0151890a-be42-473e-a33d-7b89c6c10e04"
]
}
},
{
"Id": "814ff38c-ee38-48bd-8245-a8107dc10af3",
"SeriesId": "351ef5ee-4e67-49df-a08e-c03f848c89dc",
"AccessorID": "4ed122ff-882d-44c4-b58a-3fb34be92ac2",
"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": "e6ec3e63-8f71-4db0-b471-3eeaedf23255",
"ScheduledByID": "b863600e-98ca-4f21-8070-fddcfd34bc3d",
"DeletedDates": [
"2026-08-10T01:49:51Z",
"2026-08-10T01:49:51Z"
],
"ClearedDates": [
"2026-08-10T01:49:51Z",
"2026-08-10T01:49:51Z"
],
"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-10T01:49:51Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-08-10T01:49:51Z",
"CreateDate": "2026-08-10T01:49:51Z",
"OccurTime": "2026-08-10T01:49:51Z",
"OccurEndTime": "2026-08-10T01:49:51Z",
"StartTime": "2026-08-10T01:49:51Z",
"EndTime": "2026-08-10T01:49:51Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"2b843730-e8fd-4590-aa2e-5cd7fe4df61c",
"697c9b02-c45f-44ca-973c-e1946f6dd9c5"
],
"Companies": [
"6b722965-a15c-4d4e-9047-112685ab6ea4",
"3c86d1c1-eee3-48c6-96c5-2058622bed3a"
],
"Groups": [
"7af01e55-0375-4267-94a1-0ad7a4153385",
"2ae90cf2-c70a-467e-862d-f95d5407ff16"
],
"Opportunities": [
"0d13c3b6-6fdf-463f-944c-51ed1ba63d7b",
"0151890a-be42-473e-a33d-7b89c6c10e04"
]
}
}
]