# Seam: API Reference ## API Reference ### Getting Started - [Introduction](https://docs.seam.co/api/index.md): The Seam API lets you control smart locks, thermostats, access control systems, and more through a unified REST interface. - [SDK Installation](https://docs.seam.co/api/installation.md): Install a Seam SDK in your preferred language—JavaScript, Python, Ruby, PHP, or C#—to start building integrations with the Seam API in minutes. - [MCP Installation](https://docs.seam.co/api/mcp-installation.md): Connect the Seam Docs MCP server to Claude to search Seam's API reference and device database from inside your conversations. - [Authentication](https://docs.seam.co/api/authentication.md): Learn how to authenticate with the Seam API by exporting your API key as an environment variable that the Seam client libraries pick up automatically. - [Pagination](https://docs.seam.co/api/pagination.md): Learn how to paginate Seam API list endpoints using the limit and page_cursor parameters and the pagination response object for faster, efficient apps. - [Rate Limits and Guardrails](https://docs.seam.co/api/rate-limits-and-guardrails.md): Learn the Seam API rate limits and guardrails, how 429 Too Many Requests responses work, and how to retry requests for reliable device load. ### Granting Access #### Access Grants - [The Access Grant Object](https://docs.seam.co/api/access_grants/object.md): Learn how the access_grant object grants a user identity access to spaces, entrances, and devices through mobile keys, plastic cards, and PIN codes. - [Access Grant Events](https://docs.seam.co/api/access_grants/events.md): Webhook events that Seam emits for the Access Grant resource, with example payloads and properties. - [Access Grant Errors and Warnings](https://docs.seam.co/api/access_grants/errors.md): Errors and warnings that Seam reports on the Access Grant resource, each with its code and meaning. - [Delete an Access Grant](https://docs.seam.co/api/access_grants/delete.md): Delete an Access Grant. - [Get an Access Grant](https://docs.seam.co/api/access_grants/get.md): Get an Access Grant. - [Get related Access Grant resources](https://docs.seam.co/api/access_grants/get_related.md): Gets all related resources for one or more Access Grants. - [List Access Grants](https://docs.seam.co/api/access_grants/list.md): Gets an Access Grant. - [Add Requested Access Methods to Access Grant](https://docs.seam.co/api/access_grants/request_access_methods.md): Adds additional requested access methods to an existing Access Grant. - [Create an Access Grant](https://docs.seam.co/api/access_grants/create.md): Creates a new [Access Grant](/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entra… - [Update an Access Grant](https://docs.seam.co/api/access_grants/update.md): Updates an existing Access Grant's time window. - [Delete an Access Grant](https://docs.seam.co/api/access_grants/delete.md): Delete an Access Grant. - [Get an Access Grant](https://docs.seam.co/api/access_grants/get.md): Get an Access Grant. - [Get related Access Grant resources](https://docs.seam.co/api/access_grants/get_related.md): Gets all related resources for one or more Access Grants. - [List Access Grants](https://docs.seam.co/api/access_grants/list.md): Gets an Access Grant. - [Update an Access Grant](https://docs.seam.co/api/access_grants/update.md): Updates an existing Access Grant's time window. ##### Unmanaged - [Get an Unmanaged Access Grant](https://docs.seam.co/api/access_grants/unmanaged/get.md): Get an unmanaged Access Grant (where is_managed = false). - [List Unmanaged Access Grants](https://docs.seam.co/api/access_grants/unmanaged/list.md): Gets unmanaged Access Grants (where is_managed = false). - [Update an Unmanaged Access Grant](https://docs.seam.co/api/access_grants/unmanaged/update.md): Updates an unmanaged Access Grant to make it managed. #### Access Methods - [The Access Method Object](https://docs.seam.co/api/access_methods/object.md): Learn how the access_method object describes the modes of access for an Access Grant, such as PIN codes, plastic cards, and mobile keys. - [Access Method Events](https://docs.seam.co/api/access_methods/events.md): Webhook events that Seam emits for the Access Method resource, with example payloads and properties. - [Access Method Errors and Warnings](https://docs.seam.co/api/access_methods/errors.md): Errors and warnings that Seam reports on the Access Method resource, each with its code and meaning. - [Assign a Card Credential to an Access Method](https://docs.seam.co/api/access_methods/assign_card.md): Assigns a pre-registered card credential, identified by `card_number`, to a card-mode access method. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be used for access. Assigning a card credential also t… - [Delete an Access Method](https://docs.seam.co/api/access_methods/delete.md): Deletes an access method. - [Delete an Access Method](https://docs.seam.co/api/access_methods/delete.md): Deletes an access method. - [Encode an Access Method](https://docs.seam.co/api/access_methods/encode.md): Encodes an existing access method onto a plastic card placed on the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [Get an Access Method](https://docs.seam.co/api/access_methods/get.md): Gets an access method. - [Get related Access Method resources](https://docs.seam.co/api/access_methods/get_related.md): Gets all related resources for one or more Access Methods. - [List Access Methods](https://docs.seam.co/api/access_methods/list.md): Lists all access methods, usually filtered by Access Grant. - [Get an Access Method](https://docs.seam.co/api/access_methods/get.md): Gets an access method. - [Get related Access Method resources](https://docs.seam.co/api/access_methods/get_related.md): Gets all related resources for one or more Access Methods. - [List Access Methods](https://docs.seam.co/api/access_methods/list.md): Lists all access methods, usually filtered by Access Grant. - [Unlock a Door with an Access Method](https://docs.seam.co/api/access_methods/unlock_door.md): Remotely unlocks a specified [entrance](/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation. ##### Unmanaged - [Get an Unmanaged Access Method](https://docs.seam.co/api/access_methods/unmanaged/get.md): Gets an unmanaged access method (where is_managed = false). - [List Unmanaged Access Methods](https://docs.seam.co/api/access_methods/unmanaged/list.md): Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant. ### Devices and Systems #### Devices - [The Device Object](https://docs.seam.co/api/devices/object.md): Learn how the device object represents a smart lock, thermostat, sensor, or other device connected to Seam, including its properties and events. - [Device Events](https://docs.seam.co/api/devices/events.md): Webhook events that Seam emits for the Device resource, with example payloads and properties. - [Device Errors and Warnings](https://docs.seam.co/api/devices/errors.md): Errors and warnings that Seam reports on the Device resource, each with its code and meaning. - [Get a Device](https://docs.seam.co/api/devices/get.md): Returns a specified [device](/core-concepts/devices). - [List Device Providers](https://docs.seam.co/api/devices/list_device_providers.md): Returns a list of all device providers. - [List Devices](https://docs.seam.co/api/devices/list.md): Returns a list of all [devices](/core-concepts/devices). - [Update a Device](https://docs.seam.co/api/devices/update.md): Updates a specified [device](/core-concepts/devices). - [Get a Device](https://docs.seam.co/api/devices/get.md): Returns a specified [device](/core-concepts/devices). - [List Devices](https://docs.seam.co/api/devices/list.md): Returns a list of all [devices](/core-concepts/devices). - [List Device Providers](https://docs.seam.co/api/devices/list_device_providers.md): Returns a list of all device providers. - [Report Provider Metadata](https://docs.seam.co/api/devices/report_provider_metadata.md): Updates provider-specific metadata for devices. - [Update a Device](https://docs.seam.co/api/devices/update.md): Updates a specified [device](/core-concepts/devices). ##### Simulations - [Device Simulations](https://docs.seam.co/api/devices/simulate/object.md): Use the device simulation endpoints to connect, disconnect, and remove sandbox devices so you can test how your app handles device state changes. - [Simulate Device Connection](https://docs.seam.co/api/devices/simulate/connect.md): Simulates connecting a device to Seam. Only applicable for [sandbox devices](/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). - [Simulate Device Disconnection](https://docs.seam.co/api/devices/simulate/disconnect.md): Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). - [Simulate Device Removal](https://docs.seam.co/api/devices/simulate/remove.md): Simulates removing a device from Seam. Only applicable for [sandbox devices](/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). - [Simulate Hub Connection](https://docs.seam.co/api/devices/simulate/connect_to_hub.md): Simulates bringing the Wi‑Fi hub (bridge) back online for a device. Only applicable for sandbox workspaces and currently implemented for August and TTLock locks. This will clear the `hub_disconnected` error on the device. - [Simulate Hub Disconnection](https://docs.seam.co/api/devices/simulate/disconnect_from_hub.md): Simulates taking the Wi‑Fi hub (bridge) offline for a device. Only applicable for sandbox workspaces and currently implemented for August, TTLock, and IglooHome devices. This will set the `hub_disconnected` error on the device, or mark the IglooHome bridge offline in sandbox. - [Simulate Paid Subscription](https://docs.seam.co/api/devices/simulate/paid_subscription.md): Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only). Send `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription. The actual device error is created/cleared by the poller after this state change. ##### Unmanaged Devices - [Unmanaged Devices](https://docs.seam.co/api/devices/unmanaged/object.md): Learn how the unmanaged_device object exposes a limited set of properties and events for a device you cannot control until you convert it to managed. - [Unmanaged Devices Events](https://docs.seam.co/api/devices/unmanaged/events.md): Webhook events that Seam emits for the Unmanaged Devices resource, with example payloads and properties. - [Unmanaged Devices Errors and Warnings](https://docs.seam.co/api/devices/unmanaged/errors.md): Errors and warnings that Seam reports on the Unmanaged Devices resource, each with its code and meaning. - [Get an Unmanaged Device](https://docs.seam.co/api/devices/unmanaged/get.md): Returns a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). - [List Unmanaged Devices](https://docs.seam.co/api/devices/unmanaged/list.md): Returns a list of all [unmanaged devices](/core-concepts/devices/managed-and-unmanaged-devices). - [Update an Unmanaged Device](https://docs.seam.co/api/devices/unmanaged/update.md): Updates a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. #### Locks - [The Lock Object](https://docs.seam.co/api/locks/object.md): Learn how the device object represents a smart lock connected to Seam, including its lock-specific properties, capabilities, errors, and events. - [Lock Events](https://docs.seam.co/api/locks/events.md): Webhook events that Seam emits for the Lock resource, with example payloads and properties. - [Lock Errors and Warnings](https://docs.seam.co/api/locks/errors.md): Errors and warnings that Seam reports on the Lock resource, each with its code and meaning. - [Get a Lock](https://docs.seam.co/api/locks/get.md): Deprecated. Use `/devices/get` instead. - [List Locks](https://docs.seam.co/api/locks/list.md): Returns a list of all [locks](/low-level-apis/smart-locks). - [Get a Lock](https://docs.seam.co/api/locks/get.md): Deprecated. Use `/devices/get` instead. - [List Locks](https://docs.seam.co/api/locks/list.md): Returns a list of all [locks](/low-level-apis/smart-locks). - [Lock a Lock](https://docs.seam.co/api/locks/lock_door.md): Locks a [lock](/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](/low-level-apis/smart-locks/lock-and-unlock). - [Unlock a Lock](https://docs.seam.co/api/locks/unlock_door.md): Unlocks a [lock](/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](/low-level-apis/smart-locks/lock-and-unlock). - [Configure Auto-Lock](https://docs.seam.co/api/locks/configure_auto_lock.md): Configures the auto-lock setting for a specified [lock](/low-level-apis/smart-locks). ##### Simulations - [Simulate a Keypad Code Entry](https://docs.seam.co/api/locks/simulate/keypad_code_entry.md): Simulates the entry of a code on a keypad. You can only perform this action for [August](/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](/core-concepts/workspaces#sandbox-workspaces). - [Simulate a Manual Lock Action Using a Keypad](https://docs.seam.co/api/locks/simulate/manual_lock_via_keypad.md): Simulates a manual lock action using a keypad. You can only perform this action for [August](/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](/core-concepts/workspaces#sandbox-workspaces). #### Thermostats - [The Thermostat Object](https://docs.seam.co/api/thermostats/object.md): Learn how the device object represents a thermostat connected to Seam, including its climate properties, capabilities, errors, warnings, and events. - [Thermostat Events](https://docs.seam.co/api/thermostats/events.md): Webhook events that Seam emits for the Thermostat resource, with example payloads and properties. - [Thermostat Errors and Warnings](https://docs.seam.co/api/thermostats/errors.md): Errors and warnings that Seam reports on the Thermostat resource, each with its code and meaning. - [Activate a Climate Preset](https://docs.seam.co/api/thermostats/activate_climate_preset.md): Activates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [Create a Climate Preset](https://docs.seam.co/api/thermostats/create_climate_preset.md): Creates a [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [Delete a Climate Preset](https://docs.seam.co/api/thermostats/delete_climate_preset.md): Deletes a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [List Thermostats](https://docs.seam.co/api/thermostats/list.md): Returns a list of all [thermostats](/capability-guides/thermostats). - [Set a Temperature Threshold](https://docs.seam.co/api/thermostats/set_temperature_threshold.md): Sets a [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. - [Delete a Climate Preset](https://docs.seam.co/api/thermostats/delete_climate_preset.md): Deletes a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [List Thermostats](https://docs.seam.co/api/thermostats/list.md): Returns a list of all [thermostats](/capability-guides/thermostats). - [Set the Fallback Climate Preset](https://docs.seam.co/api/thermostats/set_fallback_climate_preset.md): Sets a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](/capability-guides/thermostats). - [Set the Fan Mode Setting](https://docs.seam.co/api/thermostats/set_fan_mode.md): Sets the [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](/capability-guides/thermostats). - [Set the HVAC Mode](https://docs.seam.co/api/thermostats/set_hvac_mode.md): Sets the [HVAC mode](/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](/capability-guides/thermostats). - [Set to Cool Mode](https://docs.seam.co/api/thermostats/cool.md): Sets a specified [thermostat](/capability-guides/thermostats) to [cool mode](/capability-guides/thermostats/configure-current-climate-settings). - [Set to Heat Mode](https://docs.seam.co/api/thermostats/heat.md): Sets a specified [thermostat](/capability-guides/thermostats) to [heat mode](/capability-guides/thermostats/configure-current-climate-settings). - [Set to Heat-Cool (Auto) Mode](https://docs.seam.co/api/thermostats/heat_cool.md): Sets a specified [thermostat](/capability-guides/thermostats) to [heat-cool ("auto") mode](/capability-guides/thermostats/configure-current-climate-settings). - [Set to Off Mode](https://docs.seam.co/api/thermostats/off.md): Sets a specified [thermostat](/capability-guides/thermostats) to ["off" mode](/capability-guides/thermostats/configure-current-climate-settings). - [Update a Climate Preset](https://docs.seam.co/api/thermostats/update_climate_preset.md): Updates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [Set a Temperature Threshold](https://docs.seam.co/api/thermostats/set_temperature_threshold.md): Sets a [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. - [Update a Climate Preset](https://docs.seam.co/api/thermostats/update_climate_preset.md): Updates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats). - [Update the Thermostat Weekly Program](https://docs.seam.co/api/thermostats/update_weekly_program.md): Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the therm… ##### Daily Programs - [Daily Programs](https://docs.seam.co/api/thermostats/daily_programs/object.md): Learn how the thermostat_daily_program object defines periods that each apply a climate preset at a starting time to automate a thermostat day. - [Create a Thermostat Daily Program](https://docs.seam.co/api/thermostats/daily_programs/create.md): Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program. - [Delete a Thermostat Daily Program](https://docs.seam.co/api/thermostats/daily_programs/delete.md): Deletes a thermostat daily program. - [Update a Thermostat Daily Program](https://docs.seam.co/api/thermostats/daily_programs/update.md): Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program. - [Delete a Thermostat Daily Program](https://docs.seam.co/api/thermostats/daily_programs/delete.md): Deletes a thermostat daily program. - [Update a Thermostat Daily Program](https://docs.seam.co/api/thermostats/daily_programs/update.md): Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program. ##### Schedules - [Thermostat Schedules](https://docs.seam.co/api/thermostats/schedules/object.md): Learn how the thermostat_schedule object activates a climate preset on a thermostat at a starting time and deactivates it at a specified ending time. - [Create a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/create.md): Creates a new [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats). - [Delete a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/delete.md): Deletes a [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats). - [Get a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/get.md): Returns a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - [List Thermostat Schedules](https://docs.seam.co/api/thermostats/schedules/list.md): Returns a list of all [thermostat schedules](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats). - [Update a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/update.md): Updates a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - [Delete a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/delete.md): Deletes a [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats). - [Get a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/get.md): Returns a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - [List Thermostat Schedules](https://docs.seam.co/api/thermostats/schedules/list.md): Returns a list of all [thermostat schedules](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats). - [Update a Thermostat Schedule](https://docs.seam.co/api/thermostats/schedules/update.md): Updates a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). ##### Simulations - [HVAC Mode Adjusted](https://docs.seam.co/api/thermostats/simulate/hvac_mode_adjusted.md): Simulates having adjusted the [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](/capability-guides/thermostats). Only applicable for [sandbox devices](/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Si… - [Temperature Reached](https://docs.seam.co/api/thermostats/simulate/temperature_reached.md): Simulates a [thermostat](/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](/capability-guides/thermostats/testing-your-thermostat-app-wi… #### Noise Sensors - [The Noise Sensor Object](https://docs.seam.co/api/noise_sensors/object.md): Learn how the device object represents a noise sensor that measures sound levels, lets you configure thresholds, and emits disturbance events. - [List Noise Sensors](https://docs.seam.co/api/noise_sensors/list.md): Returns a list of all [noise sensors](/capability-guides/noise-sensors). ##### Simulations - [Simulate Triggering a Noise Threshold](https://docs.seam.co/api/noise_sensors/simulate/trigger_noise_threshold.md): Simulates the triggering of a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors) in a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces). ##### Noise Thresholds - [Noise Thresholds](https://docs.seam.co/api/noise_sensors/noise_thresholds/object.md): Learn how the noise_threshold object sets the limits of noise tolerated at a property, customizable for each hour of the day on a noise sensor. - [Noise Thresholds Events](https://docs.seam.co/api/noise_sensors/noise_thresholds/events.md): Webhook events that Seam emits for the Noise Thresholds resource, with example payloads and properties. - [Create a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/create.md): Creates a new [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own def… - [Delete a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/delete.md): Deletes a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](/capability-guides/noise-sensors). - [Get a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/get.md): Returns a specified [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). - [List Noise Thresholds](https://docs.seam.co/api/noise_sensors/noise_thresholds/list.md): Returns a list of all [noise thresholds](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). - [Update a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/update.md): Updates a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). - [Delete a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/delete.md): Deletes a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](/capability-guides/noise-sensors). - [Get a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/get.md): Returns a specified [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). - [List Noise Thresholds](https://docs.seam.co/api/noise_sensors/noise_thresholds/list.md): Returns a list of all [noise thresholds](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). - [Update a Noise Threshold](https://docs.seam.co/api/noise_sensors/noise_thresholds/update.md): Updates a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors). #### Access Control Systems (ACS) - [Access Control Systems](https://docs.seam.co/api/acs/object.md): Systems for managing and monitoring access to physical spaces ##### Access Groups - [The Access Group Object](https://docs.seam.co/api/acs/access_groups/object.md): Learn how the acs_access_group object defines the entrances a set of access system users can reach and, in some systems, their access schedule. - [Access Group Events](https://docs.seam.co/api/acs/access_groups/events.md): Webhook events that Seam emits for the Access Group resource, with example payloads and properties. - [Access Group Errors](https://docs.seam.co/api/acs/access_groups/errors.md): Errors that Seam reports on the Access Group resource, each with its code and meaning. - [Add an ACS User to an Access Group](https://docs.seam.co/api/acs/access_groups/add_user.md): Adds a specified [access system user](/low-level-apis/access-systems/user-management) to a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Get an Access Group](https://docs.seam.co/api/acs/access_groups/get.md): Returns a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [List Access Groups](https://docs.seam.co/api/acs/access_groups/list.md): Returns a list of all [access groups](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [List ACS Users in an Access Group](https://docs.seam.co/api/acs/access_groups/list_users.md): Returns a list of all [access system users](/low-level-apis/access-systems/user-management) in an [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [List Entrances Accessible to an Access Group](https://docs.seam.co/api/acs/access_groups/list_accessible_entrances.md): Returns a list of all accessible entrances for a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Remove an ACS User from an Access Group](https://docs.seam.co/api/acs/access_groups/remove_user.md): Removes a specified [access system user](/low-level-apis/access-systems/user-management) from a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Delete an Access Group](https://docs.seam.co/api/acs/access_groups/delete.md): Deletes a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). ##### ACS Users - [The ACS User Object](https://docs.seam.co/api/acs/users/object.md): Learn how the acs_user object represents an individual—such as an employee or resident—who holds one or more credentials in an access control system. - [ACS User Events](https://docs.seam.co/api/acs/users/events.md): Webhook events that Seam emits for the ACS User resource, with example payloads and properties. - [ACS User Errors and Warnings](https://docs.seam.co/api/acs/users/errors.md): Errors and warnings that Seam reports on the ACS User resource, each with its code and meaning. - [Add an ACS User to an Access Group](https://docs.seam.co/api/acs/users/add_to_access_group.md): Adds a specified [access system user](/low-level-apis/access-systems/user-management) to a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Add an ACS User to an Access Group](https://docs.seam.co/api/acs/users/add_to_access_group.md): Adds a specified [access system user](/low-level-apis/access-systems/user-management) to a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Create an ACS User](https://docs.seam.co/api/acs/users/create.md): Creates a new [access system user](/low-level-apis/access-systems/user-management). - [Delete an ACS User](https://docs.seam.co/api/acs/users/delete.md): Deletes a specified [access system user](/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](/low-level-apis/access-systems/managing-credentials). - [Get an ACS User](https://docs.seam.co/api/acs/users/get.md): Returns a specified [access system user](/low-level-apis/access-systems/user-management). - [List ACS User-Accessible Entrances](https://docs.seam.co/api/acs/users/list_accessible_entrances.md): Lists the [entrances](/api/acs/entrances/object) to which a specified [access system user](/low-level-apis/access-systems/user-management) has access. - [List ACS Users](https://docs.seam.co/api/acs/users/list.md): Returns a list of all [access system users](/low-level-apis/access-systems/user-management). - [Remove an ACS User from an Access Group](https://docs.seam.co/api/acs/users/remove_from_access_group.md): Removes a specified [access system user](/low-level-apis/access-systems/user-management) from a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Delete an ACS User](https://docs.seam.co/api/acs/users/delete.md): Deletes a specified [access system user](/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](/low-level-apis/access-systems/managing-credentials). - [Get an ACS User](https://docs.seam.co/api/acs/users/get.md): Returns a specified [access system user](/low-level-apis/access-systems/user-management). - [List ACS Users](https://docs.seam.co/api/acs/users/list.md): Returns a list of all [access system users](/low-level-apis/access-systems/user-management). - [List ACS User-Accessible Entrances](https://docs.seam.co/api/acs/users/list_accessible_entrances.md): Lists the [entrances](/api/acs/entrances/object) to which a specified [access system user](/low-level-apis/access-systems/user-management) has access. - [Remove an ACS User from an Access Group](https://docs.seam.co/api/acs/users/remove_from_access_group.md): Removes a specified [access system user](/low-level-apis/access-systems/user-management) from a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). - [Revoke ACS User Access to All Entrances](https://docs.seam.co/api/acs/users/revoke_access_to_all_entrances.md): Revokes access to all [entrances](/api/acs/entrances/object) for a specified [access system user](/low-level-apis/access-systems/user-management). - [Suspend an ACS User](https://docs.seam.co/api/acs/users/suspend.md): [Suspends](/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's acc… - [Unsuspend an ACS User](https://docs.seam.co/api/acs/users/unsuspend.md): [Unsuspends](/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](/low-level-apis/access-systems/user-management). While [suspending an access system user](/api/acs/users/suspend) revokes their access tempo… - [Update an ACS User](https://docs.seam.co/api/acs/users/update.md): Updates the properties of a specified [access system user](/low-level-apis/access-systems/user-management). - [Update an ACS User](https://docs.seam.co/api/acs/users/update.md): Updates the properties of a specified [access system user](/low-level-apis/access-systems/user-management). ##### Credentials - [The Credential Object](https://docs.seam.co/api/acs/credentials/object.md): Learn how the acs_credential object represents the means—such as key cards, mobile keys, or PIN codes—by which an access system user gains entry. - [Credential Events](https://docs.seam.co/api/acs/credentials/events.md): Webhook events that Seam emits for the Credential resource, with example payloads and properties. - [Credential Warnings](https://docs.seam.co/api/acs/credentials/errors.md): Warnings that Seam reports on the Credential resource, each with its code and meaning. - [Assign a Credential to an ACS User](https://docs.seam.co/api/acs/credentials/assign.md): Assigns a specified [credential](/low-level-apis/access-systems/managing-credentials) to a specified [access system user](/low-level-apis/access-systems/user-management). - [Assign a Credential to an ACS User](https://docs.seam.co/api/acs/credentials/assign.md): Assigns a specified [credential](/low-level-apis/access-systems/managing-credentials) to a specified [access system user](/low-level-apis/access-systems/user-management). - [Create a Credential for an ACS User](https://docs.seam.co/api/acs/credentials/create.md): Creates a new [credential](/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](/use-cases/granting-access) instead: they create and manage the underlying credentials for you… - [Delete a Credential](https://docs.seam.co/api/acs/credentials/delete.md): Deletes a specified [credential](/low-level-apis/access-systems/managing-credentials). - [Get a Credential](https://docs.seam.co/api/acs/credentials/get.md): Returns a specified [credential](/low-level-apis/access-systems/managing-credentials). - [List Credentials](https://docs.seam.co/api/acs/credentials/list.md): Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials). - [List Accessible Entrances](https://docs.seam.co/api/acs/credentials/list_accessible_entrances.md): Returns a list of all [entrances](/api/acs/entrances/object) to which a [credential](/api/acs/credentials/object) grants access. - [Unassign a Credential from an ACS User](https://docs.seam.co/api/acs/credentials/unassign.md): Unassigns a specified [credential](/low-level-apis/access-systems/managing-credentials) from a specified [access system user](/low-level-apis/access-systems/user-management). - [Update a Credential](https://docs.seam.co/api/acs/credentials/update.md): Updates the code and ends at date and time for a specified [credential](/low-level-apis/access-systems/managing-credentials). - [Delete a Credential](https://docs.seam.co/api/acs/credentials/delete.md): Deletes a specified [credential](/low-level-apis/access-systems/managing-credentials). - [Get a Credential](https://docs.seam.co/api/acs/credentials/get.md): Returns a specified [credential](/low-level-apis/access-systems/managing-credentials). - [List Accessible Entrances](https://docs.seam.co/api/acs/credentials/list_accessible_entrances.md): Returns a list of all [entrances](/api/acs/entrances/object) to which a [credential](/api/acs/credentials/object) grants access. - [List Credentials](https://docs.seam.co/api/acs/credentials/list.md): Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials). - [Unassign a Credential from an ACS User](https://docs.seam.co/api/acs/credentials/unassign.md): Unassigns a specified [credential](/low-level-apis/access-systems/managing-credentials) from a specified [access system user](/low-level-apis/access-systems/user-management). - [Update a Credential](https://docs.seam.co/api/acs/credentials/update.md): Updates the code and ends at date and time for a specified [credential](/low-level-apis/access-systems/managing-credentials). ##### Encoders - [The Encoder Object](https://docs.seam.co/api/acs/encoders/object.md): Learn how the acs_encoder object represents a hardware device that encodes credential data onto physical key cards within an access control system. - [Encoder Events](https://docs.seam.co/api/acs/encoders/events.md): Webhook events that Seam emits for the Encoder resource, with example payloads and properties. - [Encode a Credential](https://docs.seam.co/api/acs/encoders/encode_credential.md): Encodes an existing [credential](/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id` - [Get an Encoder](https://docs.seam.co/api/acs/encoders/get.md): Returns a specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [List Encoders](https://docs.seam.co/api/acs/encoders/list.md): Returns a list of all [encoders](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [Get an Encoder](https://docs.seam.co/api/acs/encoders/get.md): Returns a specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [List Encoders](https://docs.seam.co/api/acs/encoders/list.md): Returns a list of all [encoders](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [Scan a Credential](https://docs.seam.co/api/acs/encoders/scan_credential.md): Scans an encoded [acs_credential](/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners). - [Scan to Assign a Credential](https://docs.seam.co/api/acs/encoders/scan_to_assign_credential.md): Scans a physical card placed on the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`. - [Simulate that the Next Credential Encoding Will Fail](https://docs.seam.co/api/acs/encoders/simulate/next_credential_encode_will_fail.md): Simulates that the next attempt to encode a [credential](/low-level-apis/access-systems/managing-credentials) using the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](/core-concepts/… - [Simulate that the Next Credential Encoding Will Succeed](https://docs.seam.co/api/acs/encoders/simulate/next_credential_encode_will_succeed.md): Simulates that the next attempt to encode a [credential](/low-level-apis/access-systems/managing-credentials) using the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](/core-concep… - [Simulate that the Next Credential Scan Will Fail](https://docs.seam.co/api/acs/encoders/simulate/next_credential_scan_will_fail.md): Simulates that the next attempt to scan a [credential](/low-level-apis/access-systems/managing-credentials) using the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](/core-concepts/wo… - [Simulate that the Next Credential Scan Will Succeed](https://docs.seam.co/api/acs/encoders/simulate/next_credential_scan_will_succeed.md): Simulates that the next attempt to scan a [credential](/low-level-apis/access-systems/managing-credentials) using the specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](/core-concepts… ##### Entrances - [The Entrance Object](https://docs.seam.co/api/acs/entrances/object.md): Learn how the acs_entrance object represents a secured door, gate, or zone within an access control system, and how to list its credentials. - [Entrance Events](https://docs.seam.co/api/acs/entrances/events.md): Webhook events that Seam emits for the Entrance resource, with example payloads and properties. - [Entrance Warnings](https://docs.seam.co/api/acs/entrances/errors.md): Warnings that Seam reports on the Entrance resource, each with its code and meaning. - [Get an Entrance](https://docs.seam.co/api/acs/entrances/get.md): Returns a specified [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details). - [Get an Entrance](https://docs.seam.co/api/acs/entrances/get.md): Returns a specified [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details). - [Grant an ACS User Access to an Entrance](https://docs.seam.co/api/acs/entrances/grant_access.md): Grants a specified [access system user](/low-level-apis/access-systems/user-management) access to a specified [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details). - [List Credentials with Access to an Entrance](https://docs.seam.co/api/acs/entrances/list_credentials_with_access.md): Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](/low-level-apis/access-systems/retrieving-entrance-details). - [List Entrances](https://docs.seam.co/api/acs/entrances/list.md): Returns a list of all [access system entrances](/low-level-apis/access-systems/retrieving-entrance-details). - [List Entrances](https://docs.seam.co/api/acs/entrances/list.md): Returns a list of all [access system entrances](/low-level-apis/access-systems/retrieving-entrance-details). - [List Credentials with Access to an Entrance](https://docs.seam.co/api/acs/entrances/list_credentials_with_access.md): Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](/low-level-apis/access-systems/retrieving-entrance-details). - [Unlock an Entrance](https://docs.seam.co/api/acs/entrances/unlock.md): Remotely unlocks a specified [entrance](/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation. ##### Systems - [The ACS System Object](https://docs.seam.co/api/acs/systems/object.md): Learn how the acs_system object represents an access control system in which you create users and credentials to grant them access at entrances. - [ACS System Events](https://docs.seam.co/api/acs/systems/events.md): Webhook events that Seam emits for the ACS System resource, with example payloads and properties. - [ACS System Errors and Warnings](https://docs.seam.co/api/acs/systems/errors.md): Errors and warnings that Seam reports on the ACS System resource, each with its code and meaning. - [Get an ACS System](https://docs.seam.co/api/acs/systems/get.md): Returns a specified [access system](/low-level-apis/access-systems). - [List ACS Systems](https://docs.seam.co/api/acs/systems/list.md): Returns a list of all [access systems](/low-level-apis/access-systems). - [List Compatible Credential Manager ACS Systems](https://docs.seam.co/api/acs/systems/list_compatible_credential_manager_acs_systems.md): Returns a list of all credential manager systems that are compatible with a specified [access system](/low-level-apis/access-systems). - [Get an ACS System](https://docs.seam.co/api/acs/systems/get.md): Returns a specified [access system](/low-level-apis/access-systems). - [List ACS Systems](https://docs.seam.co/api/acs/systems/list.md): Returns a list of all [access systems](/low-level-apis/access-systems). - [List Compatible Credential Manager ACS Systems](https://docs.seam.co/api/acs/systems/list_compatible_credential_manager_acs_systems.md): Returns a list of all credential manager systems that are compatible with a specified [access system](/low-level-apis/access-systems). - [Report Devices](https://docs.seam.co/api/acs/systems/report_devices.md): Reports ACS system device status including encoders and entrances. ### Setup #### Connect Webviews - [The Connect Webview Object](https://docs.seam.co/api/connect_webviews/object.md): Learn how the connect_webview object embeds a client-side flow that walks your users through linking their device or system accounts to Seam. - [Connect Webview Events](https://docs.seam.co/api/connect_webviews/events.md): Webhook events that Seam emits for the Connect Webview resource, with example payloads and properties. - [Create a Connect Webview](https://docs.seam.co/api/connect_webviews/create.md): Creates a new [Connect Webview](/core-concepts/connect-webviews). - [Delete a Connect Webview](https://docs.seam.co/api/connect_webviews/delete.md): Deletes a [Connect Webview](/core-concepts/connect-webviews). - [Get a Connect Webview](https://docs.seam.co/api/connect_webviews/get.md): Returns a specified [Connect Webview](/core-concepts/connect-webviews). - [List Connect Webviews](https://docs.seam.co/api/connect_webviews/list.md): Returns a list of all [Connect Webviews](/core-concepts/connect-webviews). - [Delete a Connect Webview](https://docs.seam.co/api/connect_webviews/delete.md): Deletes a [Connect Webview](/core-concepts/connect-webviews). - [Get a Connect Webview](https://docs.seam.co/api/connect_webviews/get.md): Returns a specified [Connect Webview](/core-concepts/connect-webviews). - [List Connect Webviews](https://docs.seam.co/api/connect_webviews/list.md): Returns a list of all [Connect Webviews](/core-concepts/connect-webviews). #### Connected Accounts - [The Connected Account Object](https://docs.seam.co/api/connected_accounts/object.md): Learn how the connected_account object represents an external third-party account your user has authorized Seam to access, such as an August account. - [Connected Account Events](https://docs.seam.co/api/connected_accounts/events.md): Webhook events that Seam emits for the Connected Account resource, with example payloads and properties. - [Connected Account Errors and Warnings](https://docs.seam.co/api/connected_accounts/errors.md): Errors and warnings that Seam reports on the Connected Account resource, each with its code and meaning. - [Delete a Connected Account](https://docs.seam.co/api/connected_accounts/delete.md): Deletes a specified [connected account](/core-concepts/connected-accounts). - [Get a Connected Account](https://docs.seam.co/api/connected_accounts/get.md): Returns a specified [connected account](/core-concepts/connected-accounts). - [List Connected Accounts](https://docs.seam.co/api/connected_accounts/list.md): Returns a list of all [connected accounts](/core-concepts/connected-accounts). - [Delete a Connected Account](https://docs.seam.co/api/connected_accounts/delete.md): Deletes a specified [connected account](/core-concepts/connected-accounts). - [Get a Connected Account](https://docs.seam.co/api/connected_accounts/get.md): Returns a specified [connected account](/core-concepts/connected-accounts). - [List Connected Accounts](https://docs.seam.co/api/connected_accounts/list.md): Returns a list of all [connected accounts](/core-concepts/connected-accounts). - [Sync a Connected Account](https://docs.seam.co/api/connected_accounts/sync.md): Request a [connected account](/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. - [Update a Connected Account](https://docs.seam.co/api/connected_accounts/update.md): Updates a [connected account](/core-concepts/connected-accounts). - [Update a Connected Account](https://docs.seam.co/api/connected_accounts/update.md): Updates a [connected account](/core-concepts/connected-accounts). ##### Simulations - [Simulate Connected Account Disconnection](https://docs.seam.co/api/connected_accounts/simulate/disconnect.md): Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](/core-concepts/workspaces#sandbox-workspaces). #### User Identities - [The User Identity Object](https://docs.seam.co/api/user_identities/object.md): Learn how the user_identity object links a person to their application user account so you can manage their mobile credentials and access in Seam. - [User Identity Errors and Warnings](https://docs.seam.co/api/user_identities/errors.md): Errors and warnings that Seam reports on the User Identity resource, each with its code and meaning. - [Add an ACS User to a User Identity](https://docs.seam.co/api/user_identities/add_acs_user.md): Adds a specified [access system user](/low-level-apis/access-systems/user-management) to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Add an ACS User to a User Identity](https://docs.seam.co/api/user_identities/add_acs_user.md): Adds a specified [access system user](/low-level-apis/access-systems/user-management) to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Create a User Identity](https://docs.seam.co/api/user_identities/create.md): Creates a new [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Delete a User Identity](https://docs.seam.co/api/user_identities/delete.md): Deletes a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](/api/acs/credentials/object), [acs users](/api/acs/users/obje… - [Delete a User Identity](https://docs.seam.co/api/user_identities/delete.md): Deletes a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](/api/acs/credentials/object), [acs users](/api/acs/users/obje… - [Generate an Instant Key](https://docs.seam.co/api/user_identities/generate_instant_key.md): Generates a new [instant key](/use-cases/granting-access/using-instant-keys) for a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Get a User Identity](https://docs.seam.co/api/user_identities/get.md): Returns a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Grant a User Identity Access to a Device](https://docs.seam.co/api/user_identities/grant_access_to_device.md): Grants a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](/core-concepts/devices). - [List Accessible Devices for a User Identity](https://docs.seam.co/api/user_identities/list_accessible_devices.md): Returns a list of all [devices](/core-concepts/devices) associated with a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and… - [List ACS Systems Associated with a User Identity](https://docs.seam.co/api/user_identities/list_acs_systems.md): Returns a list of all [access systems](/low-level-apis/access-systems) associated with a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [List ACS Users Associated with a User Identity](https://docs.seam.co/api/user_identities/list_acs_users.md): Returns a list of all [access system users](/low-level-apis/access-systems/user-management) assigned to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [List User Identities](https://docs.seam.co/api/user_identities/list.md): Returns a list of all [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Get a User Identity](https://docs.seam.co/api/user_identities/get.md): Returns a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Grant a User Identity Access to a Device](https://docs.seam.co/api/user_identities/grant_access_to_device.md): Grants a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](/core-concepts/devices). - [List User Identities](https://docs.seam.co/api/user_identities/list.md): Returns a list of all [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [List Accessible Devices for a User Identity](https://docs.seam.co/api/user_identities/list_accessible_devices.md): Returns a list of all [devices](/core-concepts/devices) associated with a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and… - [List Accessible Entrances for a User Identity](https://docs.seam.co/api/user_identities/list_accessible_entrances.md): Returns a list of all [ACS entrances](/api/acs/entrances/object) accessible to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user ide… - [List ACS Systems Associated with a User Identity](https://docs.seam.co/api/user_identities/list_acs_systems.md): Returns a list of all [access systems](/low-level-apis/access-systems) associated with a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [List ACS Users Associated with a User Identity](https://docs.seam.co/api/user_identities/list_acs_users.md): Returns a list of all [access system users](/low-level-apis/access-systems/user-management) assigned to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Merge User Identities](https://docs.seam.co/api/user_identities/merge.md): Merges one or more [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. - [Remove an ACS User from a User Identity](https://docs.seam.co/api/user_identities/remove_acs_user.md): Removes a specified [access system user](/low-level-apis/access-systems/user-management) from a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Revoke Access to a Device from a User Identity](https://docs.seam.co/api/user_identities/revoke_access_to_device.md): Revokes access to a specified [device](/core-concepts/devices) from a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Update a User Identity](https://docs.seam.co/api/user_identities/update.md): Updates a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Remove an ACS User from a User Identity](https://docs.seam.co/api/user_identities/remove_acs_user.md): Removes a specified [access system user](/low-level-apis/access-systems/user-management) from a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Revoke Access to a Device from a User Identity](https://docs.seam.co/api/user_identities/revoke_access_to_device.md): Revokes access to a specified [device](/core-concepts/devices) from a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [Update a User Identity](https://docs.seam.co/api/user_identities/update.md): Updates a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - [List Accessible Entrances for a User Identity](https://docs.seam.co/api/user_identities/list_accessible_entrances.md): Returns a list of all [ACS entrances](/api/acs/entrances/object) accessible to a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user ide… ##### Unmanaged - [Get an Unmanaged User Identity](https://docs.seam.co/api/user_identities/unmanaged/get.md): Returns a specified unmanaged [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). - [List Unmanaged User Identities](https://docs.seam.co/api/user_identities/unmanaged/list.md): Returns a list of all unmanaged [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). - [Update an Unmanaged User Identity](https://docs.seam.co/api/user_identities/unmanaged/update.md): Updates an unmanaged [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. #### Workspaces - [The Workspace Object](https://docs.seam.co/api/workspaces/object.md): Learn how the workspace object represents an isolated Seam environment that holds your devices, connected accounts, and resources, with sandbox support. - [Create a Workspace](https://docs.seam.co/api/workspaces/create.md): Creates a new [workspace](/core-concepts/workspaces). - [Get a Workspace](https://docs.seam.co/api/workspaces/get.md): Returns the [workspace](/core-concepts/workspaces) associated with the authentication value. - [List Workspaces](https://docs.seam.co/api/workspaces/list.md): Returns a list of [workspaces](/core-concepts/workspaces) associated with the authentication value. - [Get a Workspace](https://docs.seam.co/api/workspaces/get.md): Returns the [workspace](/core-concepts/workspaces) associated with the authentication value. - [List Workspaces](https://docs.seam.co/api/workspaces/list.md): Returns a list of [workspaces](/core-concepts/workspaces) associated with the authentication value. - [Reset a Sandbox Workspace](https://docs.seam.co/api/workspaces/reset_sandbox.md): Resets the [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. - [Update a Workspace](https://docs.seam.co/api/workspaces/update.md): Updates the [workspace](/core-concepts/workspaces) associated with the authentication value. - [Update a Workspace](https://docs.seam.co/api/workspaces/update.md): Updates the [workspace](/core-concepts/workspaces) associated with the authentication value. #### Client Sessions - [The Client Session Object](https://docs.seam.co/api/client_sessions/object.md): Learn how the client_session object restricts your users to their own devices using a custom user_identifier_key that scopes Seam API results. - [Client Session Events](https://docs.seam.co/api/client_sessions/events.md): Webhook events that Seam emits for the Client Session resource, with example payloads and properties. - [Create a Client Session](https://docs.seam.co/api/client_sessions/create.md): Creates a new [client session](/core-concepts/authentication/client-session-tokens). - [Delete a Client Session](https://docs.seam.co/api/client_sessions/delete.md): Deletes a [client session](/core-concepts/authentication/client-session-tokens). - [Get a Client Session](https://docs.seam.co/api/client_sessions/get.md): Returns a specified [client session](/core-concepts/authentication/client-session-tokens). - [Create a Client Session](https://docs.seam.co/api/client_sessions/create.md): Creates a new [client session](/core-concepts/authentication/client-session-tokens). - [Delete a Client Session](https://docs.seam.co/api/client_sessions/delete.md): Deletes a [client session](/core-concepts/authentication/client-session-tokens). - [Get a Client Session](https://docs.seam.co/api/client_sessions/get.md): Returns a specified [client session](/core-concepts/authentication/client-session-tokens). - [Get or Create a Client Session](https://docs.seam.co/api/client_sessions/get_or_create.md): Returns a [client session](/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. - [Grant Access to a Client Session](https://docs.seam.co/api/client_sessions/grant_access.md): Grants a [client session](/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](/core-concepts/connect-webviews), [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identi… - [List Client Sessions](https://docs.seam.co/api/client_sessions/list.md): Returns a list of all [client sessions](/core-concepts/authentication/client-session-tokens). - [Grant Access to a Client Session](https://docs.seam.co/api/client_sessions/grant_access.md): Grants a [client session](/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](/core-concepts/connect-webviews), [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identi… - [List Client Sessions](https://docs.seam.co/api/client_sessions/list.md): Returns a list of all [client sessions](/core-concepts/authentication/client-session-tokens). - [Revoke a Client Session](https://docs.seam.co/api/client_sessions/revoke.md): Revokes a [client session](/core-concepts/authentication/client-session-tokens). #### Customers - [The Customer Object](https://docs.seam.co/api/customers/object.md): Learn how the customer_portal object provides a hosted, customizable interface for managing device access that you can share or embed in your product. - [Create Customer Portal](https://docs.seam.co/api/customers/create_portal.md): Creates a new customer portal magic link with configurable features. - [Delete Customer Data](https://docs.seam.co/api/customers/delete_data.md): Deletes customer data including resources like spaces, properties, rooms, users, etc. This will delete the partner resources and any related Seam resources (user identities, access grants, spaces). - [Delete Customer Data](https://docs.seam.co/api/customers/delete_data.md): Deletes customer data including resources like spaces, properties, rooms, users, etc. This will delete the partner resources and any related Seam resources (user identities, access grants, spaces). - [Push Customer Data](https://docs.seam.co/api/customers/push_data.md): Pushes customer data including resources like spaces, properties, rooms, users, etc. #### Spaces - [The Space Object](https://docs.seam.co/api/spaces/object.md): Learn how the space object groups devices and entrances together so you can assign access to an entire space and grant access more efficiently. - [Space Events](https://docs.seam.co/api/spaces/events.md): Webhook events that Seam emits for the Space resource, with example payloads and properties. - [Add a Connected Account to a Space](https://docs.seam.co/api/spaces/add_connected_account.md): Adds a [connected account](/core-concepts/connected-accounts) to a specific space. - [Add Devices to a Space](https://docs.seam.co/api/spaces/add_devices.md): Adds devices to a specific space. - [Add Entrances to a Space](https://docs.seam.co/api/spaces/add_acs_entrances.md): Adds [entrances](/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. - [Add Entrances to a Space](https://docs.seam.co/api/spaces/add_acs_entrances.md): Adds [entrances](/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. - [Add a Connected Account to a Space](https://docs.seam.co/api/spaces/add_connected_account.md): Adds a [connected account](/core-concepts/connected-accounts) to a specific space. - [Add Devices to a Space](https://docs.seam.co/api/spaces/add_devices.md): Adds devices to a specific space. - [Create a Space](https://docs.seam.co/api/spaces/create.md): Creates a new space. - [Delete a Space](https://docs.seam.co/api/spaces/delete.md): Deletes a space. - [Get a Space](https://docs.seam.co/api/spaces/get.md): Gets a space. - [Get related Space resources](https://docs.seam.co/api/spaces/get_related.md): Gets all related resources for one or more Spaces. - [List Spaces](https://docs.seam.co/api/spaces/list.md): Returns a list of all spaces. - [Remove Entrances from a Space](https://docs.seam.co/api/spaces/remove_acs_entrances.md): Removes [entrances](/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. - [Remove a Connected Account from a Space](https://docs.seam.co/api/spaces/remove_connected_account.md): Removes a [connected account](/core-concepts/connected-accounts) from a specific space. - [Remove Devices from a Space](https://docs.seam.co/api/spaces/remove_devices.md): Removes devices from a specific space. - [Update a Space](https://docs.seam.co/api/spaces/update.md): Updates an existing space. - [Delete a Space](https://docs.seam.co/api/spaces/delete.md): Deletes a space. - [Get a Space](https://docs.seam.co/api/spaces/get.md): Gets a space. - [Get related Space resources](https://docs.seam.co/api/spaces/get_related.md): Gets all related resources for one or more Spaces. - [List Spaces](https://docs.seam.co/api/spaces/list.md): Returns a list of all spaces. - [Remove a Connected Account from a Space](https://docs.seam.co/api/spaces/remove_connected_account.md): Removes a [connected account](/core-concepts/connected-accounts) from a specific space. - [Remove Devices from a Space](https://docs.seam.co/api/spaces/remove_devices.md): Removes devices from a specific space. - [Remove Entrances from a Space](https://docs.seam.co/api/spaces/remove_acs_entrances.md): Removes [entrances](/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. - [Update a Space](https://docs.seam.co/api/spaces/update.md): Updates an existing space. ### Monitoring #### Events - [The Event Object](https://docs.seam.co/api/events/object.md): Learn how the event object represents an occurrence in your workspace, such as a device action or status change, that you can list and react to. - [Get an Event](https://docs.seam.co/api/events/get.md): Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](/developer-tools/webhooks), but it enables you to retrieve an event that already took place. - [List Events](https://docs.seam.co/api/events/list.md): Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](/developer-tools/webhooks), but it enables you to filter or see events that already took place. #### Webhooks - [The Webhook Object](https://docs.seam.co/api/webhooks/object.md): Learn how the webhook object lets you receive event notifications at an endpoint URL you specify, for the set of event types you choose to subscribe to. - [Create a Webhook](https://docs.seam.co/api/webhooks/create.md): Creates a new [webhook](/developer-tools/webhooks). - [Delete a Webhook](https://docs.seam.co/api/webhooks/delete.md): Deletes a specified [webhook](/developer-tools/webhooks). - [Get a Webhook](https://docs.seam.co/api/webhooks/get.md): Gets a specified [webhook](/developer-tools/webhooks). - [List Webhooks](https://docs.seam.co/api/webhooks/list.md): Returns a list of all [webhooks](/developer-tools/webhooks). - [Update a Webhook](https://docs.seam.co/api/webhooks/update.md): Updates a specified [webhook](/developer-tools/webhooks). - [Delete a Webhook](https://docs.seam.co/api/webhooks/delete.md): Deletes a specified [webhook](/developer-tools/webhooks). - [Get a Webhook](https://docs.seam.co/api/webhooks/get.md): Gets a specified [webhook](/developer-tools/webhooks). - [List Webhooks](https://docs.seam.co/api/webhooks/list.md): Returns a list of all [webhooks](/developer-tools/webhooks). - [Update a Webhook](https://docs.seam.co/api/webhooks/update.md): Updates a specified [webhook](/developer-tools/webhooks). #### Action Attempts - [The Action Attempt Object](https://docs.seam.co/api/action_attempts/object.md): Learn how the action_attempt object tracks an attempt to perform an action against a device, letting you monitor its status and final result. - [Action Attempt Events](https://docs.seam.co/api/action_attempts/events.md): Webhook events that Seam emits for the Action Attempt resource, with example payloads and properties. - [Get an Action Attempt](https://docs.seam.co/api/action_attempts/get.md): Returns a specified [action attempt](/core-concepts/action-attempts). - [List Action Attempts](https://docs.seam.co/api/action_attempts/list.md): Returns a list of the [action attempts](/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. ### Low-Level APIs #### Access Codes - [The Access Code Object](https://docs.seam.co/api/access_codes/object.md): Learn how the access_code object represents a smart lock PIN code you can customize, track, and program across hundreds of supported keypad and pinpad locks. - [Access Code Events](https://docs.seam.co/api/access_codes/events.md): Webhook events that Seam emits for the Access Code resource, with example payloads and properties. - [Access Code Errors and Warnings](https://docs.seam.co/api/access_codes/errors.md): Errors and warnings that Seam reports on the Access Code resource, each with its code and meaning. - [Create an Access Code](https://docs.seam.co/api/access_codes/create.md): Creates a new [access code](/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint o… - [Create Multiple Linked Access Codes](https://docs.seam.co/api/access_codes/create_multiple.md): Creates new [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. - [Delete an Access Code](https://docs.seam.co/api/access_codes/delete.md): Deletes an [access code](/low-level-apis/smart-locks/access-codes). - [Generate a Code](https://docs.seam.co/api/access_codes/generate_code.md): Generates a code for an [access code](/low-level-apis/smart-locks/access-codes), given a device ID. - [Get an Access Code](https://docs.seam.co/api/access_codes/get.md): Returns a specified [access code](/low-level-apis/smart-locks/access-codes). - [List Access Codes](https://docs.seam.co/api/access_codes/list.md): Returns a list of all [access codes](/low-level-apis/smart-locks/access-codes). - [Create Multiple Linked Access Codes](https://docs.seam.co/api/access_codes/create_multiple.md): Creates new [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. - [Delete an Access Code](https://docs.seam.co/api/access_codes/delete.md): Deletes an [access code](/low-level-apis/smart-locks/access-codes). - [Generate a Code](https://docs.seam.co/api/access_codes/generate_code.md): Generates a code for an [access code](/low-level-apis/smart-locks/access-codes), given a device ID. - [Get an Access Code](https://docs.seam.co/api/access_codes/get.md): Returns a specified [access code](/low-level-apis/smart-locks/access-codes). - [List Access Codes](https://docs.seam.co/api/access_codes/list.md): Returns a list of all [access codes](/low-level-apis/smart-locks/access-codes). - [Pull a Backup Access Code](https://docs.seam.co/api/access_codes/pull_backup_access_code.md): Retrieves a backup access code for an [access code](/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](/low-level-apis/smart-locks/access-codes/backup-access-codes). - [Report Device Access Code Constraints](https://docs.seam.co/api/access_codes/report_device_constraints.md): Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices. - [Update an Access Code](https://docs.seam.co/api/access_codes/update.md): Updates a specified active or upcoming [access code](/low-level-apis/smart-locks/access-codes). - [Update Multiple Linked Access Codes](https://docs.seam.co/api/access_codes/update_multiple.md): Updates [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. - [Update an Access Code](https://docs.seam.co/api/access_codes/update.md): Updates a specified active or upcoming [access code](/low-level-apis/smart-locks/access-codes). - [Update Multiple Linked Access Codes](https://docs.seam.co/api/access_codes/update_multiple.md): Updates [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. ##### Simulations - [Simulate Creating an Unmanaged Access Code](https://docs.seam.co/api/access_codes/simulate/create_unmanaged_access_code.md): Simulates the creation of an [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces). ##### Unmanaged Access Codes - [Unmanaged Access Codes](https://docs.seam.co/api/access_codes/unmanaged/object.md): Learn how the unmanaged_access_code object represents an existing smart lock PIN code that Seam tracks but does not manage until you convert it. - [Unmanaged Access Codes Events](https://docs.seam.co/api/access_codes/unmanaged/events.md): Webhook events that Seam emits for the Unmanaged Access Codes resource, with example payloads and properties. - [Unmanaged Access Codes Errors and Warnings](https://docs.seam.co/api/access_codes/unmanaged/errors.md): Errors and warnings that Seam reports on the Unmanaged Access Codes resource, each with its code and meaning. - [Convert an Unmanaged Access Code](https://docs.seam.co/api/access_codes/unmanaged/convert_to_managed.md): Converts an [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](/low-level-apis/smart-locks/access-codes). - [Delete an Unmanaged Access Code](https://docs.seam.co/api/access_codes/unmanaged/delete.md): Deletes an [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). - [Get an Unmanaged Access Code](https://docs.seam.co/api/access_codes/unmanaged/get.md): Returns a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). - [List Unmanaged Access Codes](https://docs.seam.co/api/access_codes/unmanaged/list.md): Returns a list of all [unmanaged access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). - [Update an Unmanaged Access Code](https://docs.seam.co/api/access_codes/unmanaged/update.md): Updates a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). #### Phones - [The Phone Object](https://docs.seam.co/api/phones/object.md): Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events. - [Phone Events](https://docs.seam.co/api/phones/events.md): Webhook events that Seam emits for the Phone resource, with example payloads and properties. - [Phone Warnings](https://docs.seam.co/api/phones/errors.md): Warnings that Seam reports on the Phone resource, each with its code and meaning. - [Deactivate a Phone](https://docs.seam.co/api/phones/deactivate.md): Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). - [Get a Phone](https://docs.seam.co/api/phones/get.md): Returns a specified [phone](/capability-guides/mobile-access/managing-phones-for-a-user-identity). - [List Phones](https://docs.seam.co/api/phones/list.md): Returns a list of all [phones](/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. ##### Simulations - [Create a Sandbox Phone](https://docs.seam.co/api/phones/simulate/create_sandbox_phone.md): Creates a new simulated phone in a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). #### Instant Keys - [The Instant Key Object](https://docs.seam.co/api/instant_keys/object.md): Learn how the instant_key object lets you issue a Bluetooth mobile key with one API call and share it by link, text, or email—no app install required. - [Delete an Instant Key](https://docs.seam.co/api/instant_keys/delete.md): Deletes a specified [Instant Key](/use-cases/granting-access/using-instant-keys). - [Get an Instant Key](https://docs.seam.co/api/instant_keys/get.md): Gets an [instant key](/use-cases/granting-access/using-instant-keys). - [List Instant Keys](https://docs.seam.co/api/instant_keys/list.md): Returns a list of all [instant keys](/use-cases/granting-access/using-instant-keys). ## OpenAPI Specs - [openapi](/images/openapi.json) - [openapi](/openapi.json)