Skip to content

Add documentation for entity_ids on get_states #2616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for entity_ids on get_states #2616

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/api/websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,12 +394,14 @@ The `result` of the call will always include a `response` to account for service

## Fetching states

This will get a dump of all the current states in Home Assistant.
This will retrieve the states in Home Assistant. You can either get a dump containing all the states, or filter on some entities using `entity_ids`.

```json
{
"id": 19,
"type": "get_states"
"type": "get_states",
// Optional
"entity_ids": ["light.kitchen"]
}
```

Expand Down