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": "32b588e1-c5f2-42c6-ab00-c9cac8f96fba",
"SeriesId": "0555509d-6f58-494a-958e-5437b182f23c",
"AccessorID": "6a581d56-c8d3-4e32-8c7b-ee50698a4f73",
"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": "f1c9b369-4392-46db-9ee6-dfb6c58a2214",
"ScheduledByID": "6882b99e-d33a-4414-bfac-7d5a7b66779f",
"DeletedDates": [
"2026-11-21T07:41:09Z",
"2026-11-21T07:41:09Z"
],
"ClearedDates": [
"2026-11-21T07:41:09Z",
"2026-11-21T07:41:09Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-21T07:41:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-21T07:41:09Z",
"CreateDate": "2026-11-21T07:41:09Z",
"OccurTime": "2026-11-21T07:41:09Z",
"OccurEndTime": "2026-11-21T07:41:09Z",
"StartTime": "2026-11-21T07:41:09Z",
"EndTime": "2026-11-21T07:41:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7ce8d595-ed22-4d9f-84b8-3cfb9027089d",
"bcfbc99b-ee63-43b4-bfa8-42c81d61ddd8"
],
"Companies": [
"947df409-7e80-45fe-8fca-2935e708573e",
"e0fcb80a-78c8-4c83-bb7d-cd8749a5e5b2"
],
"Groups": [
"f171b7ea-065d-49a5-8714-017ff877d27c",
"abb4d8a4-2245-4a2f-ac27-78db59291673"
],
"Opportunities": [
"bb198c0a-8e03-4026-80b9-f81829ffcf78",
"71da3283-ce75-4628-8784-039767c34fb1"
]
}
},
{
"Id": "32b588e1-c5f2-42c6-ab00-c9cac8f96fba",
"SeriesId": "0555509d-6f58-494a-958e-5437b182f23c",
"AccessorID": "6a581d56-c8d3-4e32-8c7b-ee50698a4f73",
"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": "f1c9b369-4392-46db-9ee6-dfb6c58a2214",
"ScheduledByID": "6882b99e-d33a-4414-bfac-7d5a7b66779f",
"DeletedDates": [
"2026-11-21T07:41:09Z",
"2026-11-21T07:41:09Z"
],
"ClearedDates": [
"2026-11-21T07:41:09Z",
"2026-11-21T07:41:09Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-11-21T07:41:09Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-21T07:41:09Z",
"CreateDate": "2026-11-21T07:41:09Z",
"OccurTime": "2026-11-21T07:41:09Z",
"OccurEndTime": "2026-11-21T07:41:09Z",
"StartTime": "2026-11-21T07:41:09Z",
"EndTime": "2026-11-21T07:41:09Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"7ce8d595-ed22-4d9f-84b8-3cfb9027089d",
"bcfbc99b-ee63-43b4-bfa8-42c81d61ddd8"
],
"Companies": [
"947df409-7e80-45fe-8fca-2935e708573e",
"e0fcb80a-78c8-4c83-bb7d-cd8749a5e5b2"
],
"Groups": [
"f171b7ea-065d-49a5-8714-017ff877d27c",
"abb4d8a4-2245-4a2f-ac27-78db59291673"
],
"Opportunities": [
"bb198c0a-8e03-4026-80b9-f81829ffcf78",
"71da3283-ce75-4628-8784-039767c34fb1"
]
}
}
]