New Partial Text Search

This week, we’re excited to introduce our new partial text search capability for common fields in the Seam API. For our power users who need to manage large sets of resources, this speedy search parameter is great for building into your own UI or internal dashboards.

JavaScript
1await seam.userIdentities.list({ search: "jan" })
2// [
3//   { full_name: "Jane", ... }, 
4//   { email_address: "janet@example.com", ... }
5// ]
6
7await seam.userIdentities.list({ search: "example.com" })
8// [
9//   { email_address: "jane@example.com", ... }, 
10//   { email_address: "joe@example.com", ... }
11// ]

The search parameter searches UUID fields, as well as name and location. If you have added custom metadata to resources, you can search by this custom metadata, too.

JavaScript
1await seam.userIdentities.list({
2  search: "ce456a2b-b0c7-44d8-9908-d75871b12737"
3})
4// [
5//   { user_identity_id: "ce456a2b-b0c7-44d8-9908-d75871b12737", ... }
6// ]
7
8await seam.devices.list({ search: "grand" })
9// [
10//   { device_id: "...", custom_metadata: { "listing": "Grand View" }, ...}
11// ]
12
13await seam.devices.list({ search: "island" })
14// [
15//   { device_id: "...", location: { location_name: "Kiwi Island" }, ...}
16// ]

Further, this partial text search works naturally with Seam API pagination for large workspaces.

💡 Fun fact: This search powers our Seam Console experience!

Expanding Support

Currently, we support searching in list endpoints for the following resources:

acs_users
acs_entrances
connected_accounts
devices
locks
noise_sensors
spaces
thermostats
user_identities

We plan to expand partial text search support to more resources soon.

Start searching!

To learn about the search parameter, see our API Reference.

2025.07.18 Changelog

New

Custom metadata in events: If a device or connected account has custom data, we now return this information from our webhooks where relevant. For example, if an event payload contains a device_id, we now also return device_custom_metadata. If an event payload contains a connected_account_id, we now also return connected_account_metadata. For more information about adding custom metadata to resources, see the following topics:

New Partial Text Search