Get History or All History
GET {{host}}/api/rest/v4/data/entrydata/{{entryTypeId}}/entries/allHistory
Authorization: Bearer {{token}}
or
GET {{host}}/api/rest/v4/data/entrydata/{{entryTypeId}}/entries/history
Authorization: Bearer {{token}}
Get History either including or excluding entries modified by calculations or systems triggers.
- History endpoint returns all modified or deleted entries from a given date-time, EXCLUDING entries updated by calculations and system triggers.
- All History endpoint also includes entries updated by calculations and system triggers.
Important: These endpoints are the only endpoints where deleted entries are returned.
Params
Name | Parameter Type | Data Type | Values | Description |
---|---|---|---|---|
entryTypeId | Path | string/int | company or 2011 | Unique identifier of the object or it's name. |
modifiedSince | Query Parameter | date-time | 2020-04-26T01:16:40.030Z | Any valid ISO 8601 date-time string |
Additional Requirements
- Results are limited to 6 months.
- Deleted entries are only retrieved when
modifiedSince
parameter is specified.- Deletions are only retrieved for up to 6-month period, even if
modifiedSince
is longer.
- Deletions are only retrieved for up to 6-month period, even if
modifiedSince
needs to be in the following date format: 2020-04-26T01:16:40.030Z
DateTime Discrepancy
The entry returned for a specific DateTime may show different values in the Created Date
and Modified Date
system fields than the requested DateTime. Here are some of the scenarios where this may occur.
- If an entry is modified as part of a bulk action, the system fields capture when the action occurred while the history endpoint operates on when the change was committed to the database. Most of the time these values will be the same, but they can differ by several minutes.
- When an entry is reverted using the system's revert changes feature, the system restores the
Modified Date
to its previous value, but the history endpoint retains the reversion date. In this scenario, the history datetime value could differ by an unlimited amount
When running an integration, it is recommended that you use the history endpoint, especially when running delta queries. Because it captures when data is committed to the database, you're guaranteed to get all data changes. The DateTime of Modified Date
and modifiedSince
is not guaranteed to be identical due to the reasons explained above.
Examples
Request
GET {{host}}/api/rest/v4/data/entrydata/2013/entries/allHistory?
modifiedSince=2020-04-26T01:16:40.030Z
Response
[
{
"isDeleted": false,
"id": 2772624,
"name": "Test Interactions",
"entryListId": 2013
}
]