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": "aaea19b5-45ab-45a8-a185-37f818cf5592",
"SeriesId": "4cf86fb7-afb7-422f-8ede-d8924044a6ec",
"AccessorID": "c5930bde-51d2-432d-90c0-2102dc2571b4",
"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": "3a8a9d10-e765-4435-8fa9-a03b29c8bc68",
"ScheduledByID": "1c07299a-0792-4e48-8e95-470e130099d7",
"DeletedDates": [
"2026-10-21T19:05:16Z",
"2026-10-21T19:05:16Z"
],
"ClearedDates": [
"2026-10-21T19:05:16Z",
"2026-10-21T19:05:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-21T19:05:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-21T19:05:16Z",
"CreateDate": "2026-10-21T19:05:16Z",
"OccurTime": "2026-10-21T19:05:16Z",
"OccurEndTime": "2026-10-21T19:05:16Z",
"StartTime": "2026-10-21T19:05:16Z",
"EndTime": "2026-10-21T19:05:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0941b214-9dca-4467-bc91-dbdb067844c5",
"e26c43c2-cd7e-4f29-8d20-732a58f762a4"
],
"Companies": [
"48bc7289-c45b-4b64-b035-4f231917b715",
"50e2b2ad-bdf2-4393-b1f9-2094b4ad7304"
],
"Groups": [
"d572b374-8311-403c-bbaf-04f81837b202",
"2571f42e-df48-409a-b6a1-16fd1128da6e"
],
"Opportunities": [
"af83959d-2a6c-46f3-9680-bf1a42adaed1",
"8e350706-c398-48fb-acbe-d05e1f8d434c"
]
}
},
{
"Id": "aaea19b5-45ab-45a8-a185-37f818cf5592",
"SeriesId": "4cf86fb7-afb7-422f-8ede-d8924044a6ec",
"AccessorID": "c5930bde-51d2-432d-90c0-2102dc2571b4",
"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": "3a8a9d10-e765-4435-8fa9-a03b29c8bc68",
"ScheduledByID": "1c07299a-0792-4e48-8e95-470e130099d7",
"DeletedDates": [
"2026-10-21T19:05:16Z",
"2026-10-21T19:05:16Z"
],
"ClearedDates": [
"2026-10-21T19:05:16Z",
"2026-10-21T19:05:16Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-10-21T19:05:16Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-10-21T19:05:16Z",
"CreateDate": "2026-10-21T19:05:16Z",
"OccurTime": "2026-10-21T19:05:16Z",
"OccurEndTime": "2026-10-21T19:05:16Z",
"StartTime": "2026-10-21T19:05:16Z",
"EndTime": "2026-10-21T19:05:16Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"0941b214-9dca-4467-bc91-dbdb067844c5",
"e26c43c2-cd7e-4f29-8d20-732a58f762a4"
],
"Companies": [
"48bc7289-c45b-4b64-b035-4f231917b715",
"50e2b2ad-bdf2-4393-b1f9-2094b4ad7304"
],
"Groups": [
"d572b374-8311-403c-bbaf-04f81837b202",
"2571f42e-df48-409a-b6a1-16fd1128da6e"
],
"Opportunities": [
"af83959d-2a6c-46f3-9680-bf1a42adaed1",
"8e350706-c398-48fb-acbe-d05e1f8d434c"
]
}
}
]