Get Matter lock info

Use this action to find out what a Matter lock supports, such as the credential types it accepts, how many users it can hold, and its PIN length limits. A common use is to check a lock’s capabilities before you start adding users or credentials.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get lock info from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the lock you want to query.
6. From the actions shown for that target, select Get Matter lock info.
7. Select Save.

Options in the UI

This action has no options.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as matter.get_lock_info. Store the result in a response variable so you can use it in later steps:

action: matter.get_lock_info
target:
  entity_id: lock.front_door
response_variable: lock_info

Options in YAML

This action has no options.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching matter entity behind that target.

• Entity: one specific matter entity, such as matter.living_room.
• Device: every matter entity that belongs to a device.
• Area: every matter entity in a room or area.
• Floor: every matter entity on a floor.
• Label: every matter entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Response data

The action returns the capabilities of the lock. The response includes the following fields:

• supports_user_management: Whether the lock supports managing users and credentials.
• supported_credential_types: The credential types the lock accepts, such as pin or rfid.
• max_users: The maximum number of users the lock can hold.
• max_pin_users: The maximum number of users that can have a PIN.
• max_rfid_users: The maximum number of users that can have an RFID tag.
• max_credentials_per_user: The maximum number of credentials each user can have.
• min_pin_length: The minimum allowed PIN length.
• max_pin_length: The maximum allowed PIN length.
• min_rfid_length: The minimum allowed RFID length.
• max_rfid_length: The maximum allowed RFID length.

Fields that the lock does not report are returned without a value.

Good to know

• Not all Matter locks support user and credential management. Check supports_user_management in the response before you try to add users or credentials.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Get Matter lock users: Returns all users configured on a Matter lock.

• Set a Matter lock user: Creates or updates a user on a Matter lock.

• Set a Matter lock credential: Adds or updates a credential, such as a PIN, on a Matter lock.