Get History
home_assistant.get_history
ActionBusiness appsconnection required
Calls the Home Assistant API with the connection's credentials.
Read the state changes of named entities over a period.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Home Assistant
- Secret shape
- the long-lived access token, or {"access_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
entity_ids The entities to read, comma-separated. Home Assistant requires at least one. | string | Yes | — | — | sensor.outside_temperature |
start Start of the period, ISO-8601. Blank means 24 hours ago. | string | No | — | iso8601 format | 2026-09-08T00:00:00+00:00 |
end End of the period, ISO-8601. Blank means now. | string | No | — | iso8601 format | 2026-09-09T00:00:00+00:00 |
minimal_response Return only state and timestamps for the states after the first. | boolean | No | false | — | — |
no_attributes Leave attributes out of every state, which is much faster. | boolean | No | false | — | — |
significant_changes_only Return only the changes Home Assistant considers significant. On by default, as it is in Home Assistant; turn it off to get every recorded state change. | boolean | No | true | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"end": "2026-09-09T00:00:00+00:00",
"entity_ids": "sensor.outside_temperature",
"minimal_response": false,
"no_attributes": false,
"significant_changes_only": true,
"start": "2026-09-08T00:00:00+00:00"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
entity_ids The entities that were asked for. | array | — |
items One array of state objects per entity. | array | — |
series How many entity series `items` holds. | number | — |
count How many state rows there are across all series. | number | — |
{
"count": 0,
"entity_ids": [],
"items": [],
"series": 0
}Notes
- History needs the recorder integration; an entity it does not record comes back as no series at all.
- Unlike the other two flags, Home Assistant reads significant_changes_only as a value and defaults it to on, so it is always sent explicitly — the off position really does return every recorded change.
Related Home Assistant nodes
See Get History run in a workflow.
In a technical demo we add the Home Assistant connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.