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": "0ac59441-3229-42e7-8d00-715f1705b92a",
"SeriesId": "940b2a97-5a25-4d8b-b2c5-920a0f555c24",
"AccessorID": "7d8180d2-2481-4c3d-a08d-86611756e7a5",
"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": "b420cef0-1896-4b39-b5f9-9959ecc209b1",
"ScheduledByID": "6b3be2f1-960d-4181-9dbe-056ca539b537",
"DeletedDates": [
"2026-07-30T15:05:53Z",
"2026-07-30T15:05:53Z"
],
"ClearedDates": [
"2026-07-30T15:05:53Z",
"2026-07-30T15:05:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-30T15:05:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-30T15:05:53Z",
"CreateDate": "2026-07-30T15:05:53Z",
"OccurTime": "2026-07-30T15:05:53Z",
"OccurEndTime": "2026-07-30T15:05:53Z",
"StartTime": "2026-07-30T15:05:53Z",
"EndTime": "2026-07-30T15:05:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa0f0eff-b67c-4a01-8a1f-4e9db9164e19",
"7f7ea8f7-fd2d-4171-a7b4-7d1b39b01a91"
],
"Companies": [
"bf47dba5-7b21-4791-bb0a-bbcf3f982768",
"25073126-72e1-4441-963a-5cda88b0d3f8"
],
"Groups": [
"882d7bfb-47eb-49b9-8f4a-e887a9e56779",
"97e92e3f-e7d8-4e7d-8c0b-ea2fac753749"
],
"Opportunities": [
"01267da2-f25e-432a-8afe-ba92ec8bbef9",
"f76216f0-bdd1-4db4-8b10-2a988fc0c6c3"
]
}
},
{
"Id": "0ac59441-3229-42e7-8d00-715f1705b92a",
"SeriesId": "940b2a97-5a25-4d8b-b2c5-920a0f555c24",
"AccessorID": "7d8180d2-2481-4c3d-a08d-86611756e7a5",
"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": "b420cef0-1896-4b39-b5f9-9959ecc209b1",
"ScheduledByID": "6b3be2f1-960d-4181-9dbe-056ca539b537",
"DeletedDates": [
"2026-07-30T15:05:53Z",
"2026-07-30T15:05:53Z"
],
"ClearedDates": [
"2026-07-30T15:05:53Z",
"2026-07-30T15:05:53Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-07-30T15:05:53Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-07-30T15:05:53Z",
"CreateDate": "2026-07-30T15:05:53Z",
"OccurTime": "2026-07-30T15:05:53Z",
"OccurEndTime": "2026-07-30T15:05:53Z",
"StartTime": "2026-07-30T15:05:53Z",
"EndTime": "2026-07-30T15:05:53Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"aa0f0eff-b67c-4a01-8a1f-4e9db9164e19",
"7f7ea8f7-fd2d-4171-a7b4-7d1b39b01a91"
],
"Companies": [
"bf47dba5-7b21-4791-bb0a-bbcf3f982768",
"25073126-72e1-4441-963a-5cda88b0d3f8"
],
"Groups": [
"882d7bfb-47eb-49b9-8f4a-e887a9e56779",
"97e92e3f-e7d8-4e7d-8c0b-ea2fac753749"
],
"Opportunities": [
"01267da2-f25e-432a-8afe-ba92ec8bbef9",
"f76216f0-bdd1-4db4-8b10-2a988fc0c6c3"
]
}
}
]