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": "fb10b2cf-9bb9-45b9-a223-31eb69faea69",
"SeriesId": "35ea7eba-8e20-4d13-bf18-83e35c638b34",
"AccessorID": "572251bf-50d2-409d-8676-dd4598b73cf9",
"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": "31022d08-960c-4b94-9a5f-4049be5877cf",
"ScheduledByID": "f6e57105-682b-42cd-8a6d-56f85be354d9",
"DeletedDates": [
"2026-06-09T18:42:04Z",
"2026-06-09T18:42:04Z"
],
"ClearedDates": [
"2026-06-09T18:42:04Z",
"2026-06-09T18:42:04Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-09T18:42:04Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-09T18:42:04Z",
"CreateDate": "2026-06-09T18:42:04Z",
"OccurTime": "2026-06-09T18:42:04Z",
"OccurEndTime": "2026-06-09T18:42:04Z",
"StartTime": "2026-06-09T18:42:04Z",
"EndTime": "2026-06-09T18:42:04Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"19415e0c-d0dc-4dc5-8bb4-325f0ed0c6d0",
"c9fd4abd-1b31-4d05-b4c2-6daaff6753c6"
],
"Companies": [
"85eda1c9-60fd-4983-8964-89ed6511c626",
"3decbef8-e6eb-4121-9120-90897c0437ed"
],
"Groups": [
"a3eab9e6-e0f0-42b3-9d7c-80a6996239af",
"9acbcbed-30d4-471d-83be-50394dfee420"
],
"Opportunities": [
"cafad3fc-8b4f-462f-ae36-b481565de26d",
"4694ee1d-d576-479e-a97d-bd9e7fc6d1f7"
]
}
},
{
"Id": "fb10b2cf-9bb9-45b9-a223-31eb69faea69",
"SeriesId": "35ea7eba-8e20-4d13-bf18-83e35c638b34",
"AccessorID": "572251bf-50d2-409d-8676-dd4598b73cf9",
"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": "31022d08-960c-4b94-9a5f-4049be5877cf",
"ScheduledByID": "f6e57105-682b-42cd-8a6d-56f85be354d9",
"DeletedDates": [
"2026-06-09T18:42:04Z",
"2026-06-09T18:42:04Z"
],
"ClearedDates": [
"2026-06-09T18:42:04Z",
"2026-06-09T18:42:04Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2026-06-09T18:42:04Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-06-09T18:42:04Z",
"CreateDate": "2026-06-09T18:42:04Z",
"OccurTime": "2026-06-09T18:42:04Z",
"OccurEndTime": "2026-06-09T18:42:04Z",
"StartTime": "2026-06-09T18:42:04Z",
"EndTime": "2026-06-09T18:42:04Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"19415e0c-d0dc-4dc5-8bb4-325f0ed0c6d0",
"c9fd4abd-1b31-4d05-b4c2-6daaff6753c6"
],
"Companies": [
"85eda1c9-60fd-4983-8964-89ed6511c626",
"3decbef8-e6eb-4121-9120-90897c0437ed"
],
"Groups": [
"a3eab9e6-e0f0-42b3-9d7c-80a6996239af",
"9acbcbed-30d4-471d-83be-50394dfee420"
],
"Opportunities": [
"cafad3fc-8b4f-462f-ae36-b481565de26d",
"4694ee1d-d576-479e-a97d-bd9e7fc6d1f7"
]
}
}
]