GET api/Histories

Get all Histories matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeLink, DetailFormat

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of History
NameDescriptionTypeAdditional information
Id

SQL Column Name: [HISTORYID]

globally unique identifier

None.

Regarding

SQL Column Name: [REGARDING]

string

None.

Duration

SQL Column Name: [DURATION]

string

None.

OutlookID

string

None.

HistoryTypeID

SQL Column Name: [HISTORYTYPEID]

integer

None.

HistoryType

HistoryType

None.

Attachment

Attachment

None.

IsPrivate

boolean

None.

ManageUserId

globally unique identifier

None.

EditDate

SQL Column Name: [EDIT_DATE]

date

None.

CreateDate

SQL Column Name: [CREATE_DATE]

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": "63912ac5-2e27-4749-aed4-e21e6553bc57",
    "Regarding": "sample string 2",
    "Duration": "sample string 3",
    "OutlookID": "sample string 4",
    "HistoryTypeID": 5,
    "HistoryType": {
      "Name": "sample string 1",
      "HistoryTypeId": 2,
      "Description": "sample string 3",
      "ActivityTypeID": "sample string 4",
      "ActivityTypeName": "sample string 5",
      "IsActive": true,
      "IsCustom": true,
      "IsDefault": true,
      "IsUserRecordable": true
    },
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2025-07-19T05:43:48Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "1760cc3f-f610-4915-bc2d-3f78a571e49d",
    "EditDate": "2025-07-19T05:43:48Z",
    "CreateDate": "2025-07-19T05:43:48Z",
    "StartTime": "2025-07-19T05:43:48Z",
    "EndTime": "2025-07-19T05:43:48Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "33cea0f3-ddee-4fae-99a8-b784f598ae0e",
        "978fd9e6-98fd-4c64-8a5a-f66c8aa6a762"
      ],
      "Companies": [
        "41d016f4-59e8-4f82-a860-900798e4f212",
        "34d333cf-e5be-4638-ade9-fd019ce55559"
      ],
      "Groups": [
        "2eac943e-0caf-497a-bcfc-51b016b55287",
        "eb074468-721e-4a31-be71-21c56263ef11"
      ],
      "Opportunities": [
        "b0e6c930-678e-4a4d-bf39-b8b716d6fe0a",
        "977f8dc6-4d3b-436c-9d24-8948aed0d19d"
      ]
    }
  },
  {
    "Id": "63912ac5-2e27-4749-aed4-e21e6553bc57",
    "Regarding": "sample string 2",
    "Duration": "sample string 3",
    "OutlookID": "sample string 4",
    "HistoryTypeID": 5,
    "HistoryType": {
      "Name": "sample string 1",
      "HistoryTypeId": 2,
      "Description": "sample string 3",
      "ActivityTypeID": "sample string 4",
      "ActivityTypeName": "sample string 5",
      "IsActive": true,
      "IsCustom": true,
      "IsDefault": true,
      "IsUserRecordable": true
    },
    "Attachment": {
      "DisplayName": "sample string 1",
      "FileSize": 2.1,
      "LastModified": "2025-07-19T05:43:48Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "1760cc3f-f610-4915-bc2d-3f78a571e49d",
    "EditDate": "2025-07-19T05:43:48Z",
    "CreateDate": "2025-07-19T05:43:48Z",
    "StartTime": "2025-07-19T05:43:48Z",
    "EndTime": "2025-07-19T05:43:48Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "33cea0f3-ddee-4fae-99a8-b784f598ae0e",
        "978fd9e6-98fd-4c64-8a5a-f66c8aa6a762"
      ],
      "Companies": [
        "41d016f4-59e8-4f82-a860-900798e4f212",
        "34d333cf-e5be-4638-ade9-fd019ce55559"
      ],
      "Groups": [
        "2eac943e-0caf-497a-bcfc-51b016b55287",
        "eb074468-721e-4a31-be71-21c56263ef11"
      ],
      "Opportunities": [
        "b0e6c930-678e-4a4d-bf39-b8b716d6fe0a",
        "977f8dc6-4d3b-436c-9d24-8948aed0d19d"
      ]
    }
  }
]