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": "0be93dff-c05b-409b-97b2-6bfe419329df",
    "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-09-02T18:50:26Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "75c4cc3b-9e12-481a-b2ef-1385bed8b227",
    "EditDate": "2025-09-02T18:50:26Z",
    "CreateDate": "2025-09-02T18:50:26Z",
    "StartTime": "2025-09-02T18:50:26Z",
    "EndTime": "2025-09-02T18:50:26Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "5c32d239-221c-499e-9733-651bd4a148fe",
        "31cf76a3-2b0a-4ec3-9954-9ee9b73d4ce7"
      ],
      "Companies": [
        "f9ae6638-6aba-464f-9a69-acb5783041d0",
        "46f5a15f-fdf7-47bf-a031-137b73cfa69d"
      ],
      "Groups": [
        "71d88535-bcc4-4f85-a35e-47ba4d276c0b",
        "380b8a69-fbf6-419e-9bd3-acd747bf4efe"
      ],
      "Opportunities": [
        "46fc5798-6ec2-4703-8253-9d2955ea7b3e",
        "35847cdf-6d00-4d32-8440-dbc2cbd601f2"
      ]
    }
  },
  {
    "Id": "0be93dff-c05b-409b-97b2-6bfe419329df",
    "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-09-02T18:50:26Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "75c4cc3b-9e12-481a-b2ef-1385bed8b227",
    "EditDate": "2025-09-02T18:50:26Z",
    "CreateDate": "2025-09-02T18:50:26Z",
    "StartTime": "2025-09-02T18:50:26Z",
    "EndTime": "2025-09-02T18:50:26Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "5c32d239-221c-499e-9733-651bd4a148fe",
        "31cf76a3-2b0a-4ec3-9954-9ee9b73d4ce7"
      ],
      "Companies": [
        "f9ae6638-6aba-464f-9a69-acb5783041d0",
        "46f5a15f-fdf7-47bf-a031-137b73cfa69d"
      ],
      "Groups": [
        "71d88535-bcc4-4f85-a35e-47ba4d276c0b",
        "380b8a69-fbf6-419e-9bd3-acd747bf4efe"
      ],
      "Opportunities": [
        "46fc5798-6ec2-4703-8253-9d2955ea7b3e",
        "35847cdf-6d00-4d32-8440-dbc2cbd601f2"
      ]
    }
  }
]