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": "fc425c75-5c2f-4809-ab18-3479710e9318",
"SeriesId": "c7378dc6-2b57-4101-965b-2e0a3a22d60c",
"AccessorID": "d2185c89-59f1-4f6d-9807-7c7b9e9e7ae0",
"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": "0c302a27-58f3-4f3b-b0b7-2d9d62adfdd4",
"ScheduledByID": "526d6714-0bc8-4b7a-b513-37ed06779e7b",
"DeletedDates": [
"2026-09-01T21:29:59Z",
"2026-09-01T21:29:59Z"
],
"ClearedDates": [
"2026-09-01T21:29:59Z",
"2026-09-01T21:29:59Z"
],
"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-01T21:29:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-01T21:29:59Z",
"CreateDate": "2026-09-01T21:29:59Z",
"OccurTime": "2026-09-01T21:29:59Z",
"OccurEndTime": "2026-09-01T21:29:59Z",
"StartTime": "2026-09-01T21:29:59Z",
"EndTime": "2026-09-01T21:29:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"40529f10-d4c3-4e6c-b93c-388f9650825d",
"66711bdd-6e4f-499c-81fe-d28f8427cf4f"
],
"Companies": [
"d363864f-5e20-4b9b-b7c2-eb5250e6cf4d",
"35e605c9-5fdb-48fa-ab31-32899b0ab2c0"
],
"Groups": [
"8e5ef6a3-f569-4d6e-a109-086c7d5b8251",
"e48b92d1-8bc9-40a5-89c0-e7aa56d036f1"
],
"Opportunities": [
"f8e89407-ed52-40d6-9e47-0e5229beffe8",
"90fb5852-bdf2-4f57-bf78-d26164fb9dc6"
]
}
},
{
"Id": "fc425c75-5c2f-4809-ab18-3479710e9318",
"SeriesId": "c7378dc6-2b57-4101-965b-2e0a3a22d60c",
"AccessorID": "d2185c89-59f1-4f6d-9807-7c7b9e9e7ae0",
"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": "0c302a27-58f3-4f3b-b0b7-2d9d62adfdd4",
"ScheduledByID": "526d6714-0bc8-4b7a-b513-37ed06779e7b",
"DeletedDates": [
"2026-09-01T21:29:59Z",
"2026-09-01T21:29:59Z"
],
"ClearedDates": [
"2026-09-01T21:29:59Z",
"2026-09-01T21:29:59Z"
],
"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-01T21:29:59Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-09-01T21:29:59Z",
"CreateDate": "2026-09-01T21:29:59Z",
"OccurTime": "2026-09-01T21:29:59Z",
"OccurEndTime": "2026-09-01T21:29:59Z",
"StartTime": "2026-09-01T21:29:59Z",
"EndTime": "2026-09-01T21:29:59Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"40529f10-d4c3-4e6c-b93c-388f9650825d",
"66711bdd-6e4f-499c-81fe-d28f8427cf4f"
],
"Companies": [
"d363864f-5e20-4b9b-b7c2-eb5250e6cf4d",
"35e605c9-5fdb-48fa-ab31-32899b0ab2c0"
],
"Groups": [
"8e5ef6a3-f569-4d6e-a109-086c7d5b8251",
"e48b92d1-8bc9-40a5-89c0-e7aa56d036f1"
],
"Opportunities": [
"f8e89407-ed52-40d6-9e47-0e5229beffe8",
"90fb5852-bdf2-4f57-bf78-d26164fb9dc6"
]
}
}
]