> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Seam

> Control smart locks, access systems, thermostats, sensors, and other connected devices in a Seam workspace.

![Seam logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/seam.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=f520b24fa762ab4d336668a35a91a789)

* **Category:** internet of things
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `SEAM`
* **Version:** 20261030\_00

## Tools

> [accordion] Add Access Methods to Grant
>
> **Slug:** `SEAM_ADD_ACCESS_METHODS_TO_GRANT`
>
> Request additional PIN, card, mobile-key, or cloud-key methods for an existing access grant.
>
> #### Input Parameters
>
> **access\_grant\_id** `string` *required*
>
> UUID of the access grant to extend.
>
> **requested\_access\_methods** `array` *required*
>
> One or more additional access methods to issue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Access Grant
>
> **Slug:** `SEAM_CREATE_ACCESS_GRANT`
>
> Grant an existing or new user identity access to spaces, devices, or access-control entrances, requesting PIN, card, mobile-key, or cloud-key methods.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable name for the access grant.
>
> **ends\_at** `string`
>
> ISO 8601 end time, including a timezone offset; must be in the future and after starts\_at.
>
> **space\_ids** `array`
>
> Existing space UUIDs to grant access to.
>
> **starts\_at** `string`
>
> ISO 8601 start time, including a timezone offset.
>
> **device\_ids** `array`
>
> Standalone device UUIDs to grant access to.
>
> **space\_keys** `array`
>
> Existing unique space keys to grant access to.
>
> **user\_identity** `object`
>
> New identity to create and grant access to. Provide this or user\_identity\_id, but not both. The object cannot be empty; include full\_name, email\_address, phone\_number, or user\_identity\_key.
>
> **reservation\_key** `string`
>
> Reservation key associated with this access grant.
>
> **access\_grant\_key** `string`
>
> Unique key for this access grant within the workspace.
>
> **acs\_entrance\_ids** `array`
>
> Access-control entrance UUIDs to grant access to.
>
> **user\_identity\_id** `string`
>
> Existing user identity UUID. Provide this or user\_identity, but not both.
>
> **customization\_profile\_id** `string`
>
> Customization profile UUID to apply to the grant and its access methods.
>
> **requested\_access\_methods** `array` *required*
>
> One or more PIN, card, mobile-key, or cloud-key methods Seam should issue.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Access Grant
>
> **Slug:** `SEAM_DELETE_ACCESS_GRANT`
>
> Permanently revoke and delete an access grant by UUID, removing the access it manages.
>
> #### Input Parameters
>
> **access\_grant\_id** `string` *required*
>
> UUID of the access grant to permanently revoke and delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Access Grant
>
> **Slug:** `SEAM_GET_ACCESS_GRANT`
>
> Get one access grant by its Seam UUID or unique workspace key.
>
> #### Input Parameters
>
> **access\_grant\_id** `string`
>
> UUID of the access grant to retrieve. Provide exactly one identifier.
>
> **access\_grant\_key** `string`
>
> Unique workspace key of the access grant. Provide exactly one identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Access Grants
>
> **Slug:** `SEAM_LIST_ACCESS_GRANTS`
>
> List access grants in the workspace, optionally filtered by space, device, entrance, user identity, reservation, customer, key, or IDs; returns one cursor-controlled page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum grants to return in this page. Seam documents no verified upper bound.
>
> **space\_id** `string`
>
> Space UUID to filter grants by.
>
> **device\_id** `string`
>
> Device UUID to filter grants by.
>
> **page\_cursor** `string`
>
> Opaque next-page cursor returned by a previous call.
>
> **customer\_key** `string`
>
> Customer key to filter grants by.
>
> **acs\_system\_id** `string`
>
> Access-control system UUID to filter grants by.
>
> **access\_code\_id** `string`
>
> Access code UUID to filter grants by.
>
> **acs\_entrance\_id** `string`
>
> Access-control entrance UUID to filter grants by.
>
> **reservation\_key** `string`
>
> Reservation key to filter grants by.
>
> **access\_grant\_ids** `array`
>
> Access grant UUIDs to retrieve.
>
> **access\_grant\_key** `string`
>
> Filter by access grant key. Explicitly pass null to find grants without a key; omit this field to avoid filtering by key.
>
> **user\_identity\_id** `string`
>
> User identity UUID to filter grants by.
>
> **without\_access\_grant\_key** `boolean`
>
> Set true to return only grants without an access grant key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Action Attempts
>
> **Slug:** `SEAM_LIST_ACTION_ATTEMPTS`
>
> Inspect asynchronous Seam operation status, errors, and results in bulk by action-attempt IDs or by device, returning one cursor-controlled page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum action attempts to return in this page.
>
> **device\_id** `string`
>
> Device UUID to filter action attempts by.
>
> **page\_cursor** `string`
>
> Opaque next-page cursor returned by a previous call.
>
> **action\_attempt\_ids** `array`
>
> Action-attempt UUIDs to inspect together. Use these to poll statuses returned by prior mutations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Connected Accounts
>
> **Slug:** `SEAM_LIST_CONNECTED_ACCOUNTS`
>
> List and search provider accounts connected to the workspace, optionally filtering by space, customer, user, or metadata; returns one cursor-controlled page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum connected accounts to return in this page; must be greater than zero.
>
> **search** `string`
>
> Partial match across account ID or type, customer key, metadata, username, email, or phone.
>
> **space\_id** `string`
>
> Space UUID to filter connected accounts by.
>
> **page\_cursor** `string`
>
> Opaque next-page cursor returned by a previous call.
>
> **customer\_key** `string`
>
> Customer key to filter connected accounts by.
>
> **custom\_metadata\_has** `object`
>
> Metadata key-value pairs that each returned connected account must contain. Values may be strings or booleans.
>
> **user\_identifier\_key** `string`
>
> Internal user identifier key to filter connected accounts by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Devices
>
> **Slug:** `SEAM_LIST_DEVICES`
>
> List and search devices in the workspace, optionally filtering by account, space, IDs, type, manufacturer, customer, creation time, or metadata; returns one cursor-controlled page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum devices to return in this page. Seam documents no verified upper bound.
>
> **search** `string`
>
> Partial match across device ID, account ID, display name, metadata, or location. UUID prefixes must be at least 4 characters.
>
> **space\_id** `string`
>
> Space UUID to filter by.
>
> **device\_ids** `array`
>
> Device UUIDs to retrieve.
>
> **device\_type** `string`
>
> Single Seam device type key to filter by.
>
> **page\_cursor** `string`
>
> Opaque next-page cursor returned by a previous call.
>
> **customer\_key** `string`
>
> Customer key to filter by.
>
> **device\_types** `array`
>
> Seam device type keys to filter by. Do not combine with device\_type.
>
> **manufacturer** `string`
>
> Documented Seam manufacturer key to filter by.
>
> **created\_before** `string`
>
> ISO 8601 timestamp; return devices created before it.
>
> **connect\_webview\_id** `string`
>
> Connect Webview UUID to filter by.
>
> **custom\_metadata\_has** `object`
>
> Metadata key/value pairs that returned devices must contain.
>
> **user\_identifier\_key** `string`
>
> Your internal user identifier key to filter by.
>
> **connected\_account\_id** `string`
>
> Connected account UUID to filter by.
>
> **connected\_account\_ids** `array`
>
> Connected account UUIDs to filter by. Do not combine with connected\_account\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Spaces
>
> **Slug:** `SEAM_LIST_SPACES`
>
> List and search spaces in the workspace by name, key, or customer, returning one cursor-controlled page of grantable locations.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum spaces to return in this page. Seam documents no verified upper bound.
>
> **search** `string`
>
> Partial match across space name, space key, or customer key.
>
> **space\_key** `string`
>
> Exact unique space key to filter by.
>
> **page\_cursor** `string`
>
> Opaque next-page cursor returned by a previous call.
>
> **customer\_key** `string`
>
> Customer key to filter spaces by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Access Grant
>
> **Slug:** `SEAM_UPDATE_ACCESS_GRANT`
>
> Update an access grant's name or validity window by UUID or unique workspace key. Provide at least one of name, starts\_at, or ends\_at.
>
> #### Input Parameters
>
> **name** `string`
>
> New display name; null clears the name. At least one update field is required across name, starts\_at, and ends\_at.
>
> **ends\_at** `string`
>
> New ISO 8601 end time; null clears the end time. At least one update field is required across name, starts\_at, and ends\_at.
>
> **starts\_at** `string`
>
> New ISO 8601 start time. At least one update field is required across name, starts\_at, and ends\_at.
>
> **access\_grant\_id** `string`
>
> Grant UUID. Leave unset when identifying the grant by key; do not send both identifiers.
>
> **access\_grant\_key** `string`
>
> Grant key. Leave unset when identifying the grant by UUID; do not send both identifiers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
