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": "d7f12bb6-ac7b-4b76-ab93-bdb91a2bca96",
"SeriesId": "a4715c82-7c35-4896-935e-ae93648b7a68",
"AccessorID": "4e853062-29d9-47b7-bd48-0e345e95440d",
"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": "b36345df-3a50-4901-a2ca-f655ce3a22e2",
"ScheduledByID": "0b839dc1-97d8-4197-aae2-9ebfb280b10f",
"DeletedDates": [
"2026-11-05T23:27:29Z",
"2026-11-05T23:27:29Z"
],
"ClearedDates": [
"2026-11-05T23:27:29Z",
"2026-11-05T23:27:29Z"
],
"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-05T23:27:29Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-05T23:27:29Z",
"CreateDate": "2026-11-05T23:27:29Z",
"OccurTime": "2026-11-05T23:27:29Z",
"OccurEndTime": "2026-11-05T23:27:29Z",
"StartTime": "2026-11-05T23:27:29Z",
"EndTime": "2026-11-05T23:27:29Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6c1e17ff-e39a-4c73-95b7-3cd5089cbb71",
"841ca230-861a-4502-866d-207b53de9bb0"
],
"Companies": [
"fbffa2f7-9e17-4484-9c02-d02a2ef34580",
"bdada8ba-4d2e-4793-af28-5ee266f2e0b5"
],
"Groups": [
"e99e6494-5c01-41ae-ade8-6348b46cc8c1",
"6e6a6b85-3f63-4e47-ab54-835e253e4c91"
],
"Opportunities": [
"1a8d75ff-1dcf-4441-9f40-c2601f33cd6d",
"b89febf6-609b-490c-8ba0-6ad999f12873"
]
}
},
{
"Id": "d7f12bb6-ac7b-4b76-ab93-bdb91a2bca96",
"SeriesId": "a4715c82-7c35-4896-935e-ae93648b7a68",
"AccessorID": "4e853062-29d9-47b7-bd48-0e345e95440d",
"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": "b36345df-3a50-4901-a2ca-f655ce3a22e2",
"ScheduledByID": "0b839dc1-97d8-4197-aae2-9ebfb280b10f",
"DeletedDates": [
"2026-11-05T23:27:29Z",
"2026-11-05T23:27:29Z"
],
"ClearedDates": [
"2026-11-05T23:27:29Z",
"2026-11-05T23:27:29Z"
],
"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-05T23:27:29Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2026-11-05T23:27:29Z",
"CreateDate": "2026-11-05T23:27:29Z",
"OccurTime": "2026-11-05T23:27:29Z",
"OccurEndTime": "2026-11-05T23:27:29Z",
"StartTime": "2026-11-05T23:27:29Z",
"EndTime": "2026-11-05T23:27:29Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"6c1e17ff-e39a-4c73-95b7-3cd5089cbb71",
"841ca230-861a-4502-866d-207b53de9bb0"
],
"Companies": [
"fbffa2f7-9e17-4484-9c02-d02a2ef34580",
"bdada8ba-4d2e-4793-af28-5ee266f2e0b5"
],
"Groups": [
"e99e6494-5c01-41ae-ade8-6348b46cc8c1",
"6e6a6b85-3f63-4e47-ab54-835e253e4c91"
],
"Opportunities": [
"1a8d75ff-1dcf-4441-9f40-c2601f33cd6d",
"b89febf6-609b-490c-8ba0-6ad999f12873"
]
}
}
]