Skip to main content
Seam logo
  • Category: internet of things
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: SEAM
  • Version: 20261030_00

Tools

Slug: SEAM_ADD_ACCESS_METHODS_TO_GRANTRequest additional PIN, card, mobile-key, or cloud-key methods for an existing access grant.

Input Parameters

string
required
UUID of the access grant to extend.
array
required
One or more additional access methods to issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_CREATE_ACCESS_GRANTGrant 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

string
Human-readable name for the access grant.
string
ISO 8601 end time, including a timezone offset; must be in the future and after starts_at.
array
Existing space UUIDs to grant access to.
string
ISO 8601 start time, including a timezone offset.
array
Standalone device UUIDs to grant access to.
array
Existing unique space keys to grant access to.
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.
string
Reservation key associated with this access grant.
string
Unique key for this access grant within the workspace.
array
Access-control entrance UUIDs to grant access to.
string
Existing user identity UUID. Provide this or user_identity, but not both.
string
Customization profile UUID to apply to the grant and its access methods.
array
required
One or more PIN, card, mobile-key, or cloud-key methods Seam should issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_DELETE_ACCESS_GRANTPermanently revoke and delete an access grant by UUID, removing the access it manages.

Input Parameters

string
required
UUID of the access grant to permanently revoke and delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_GET_ACCESS_GRANTGet one access grant by its Seam UUID or unique workspace key.

Input Parameters

string
UUID of the access grant to retrieve. Provide exactly one identifier.
string
Unique workspace key of the access grant. Provide exactly one identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_LIST_ACCESS_GRANTSList 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

integer
Maximum grants to return in this page. Seam documents no verified upper bound.
string
Space UUID to filter grants by.
string
Device UUID to filter grants by.
string
Opaque next-page cursor returned by a previous call.
string
Customer key to filter grants by.
string
Access-control system UUID to filter grants by.
string
Access code UUID to filter grants by.
string
Access-control entrance UUID to filter grants by.
string
Reservation key to filter grants by.
array
Access grant UUIDs to retrieve.
string
Filter by access grant key. Explicitly pass null to find grants without a key; omit this field to avoid filtering by key.
string
User identity UUID to filter grants by.
boolean
Set true to return only grants without an access grant key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_LIST_ACTION_ATTEMPTSInspect asynchronous Seam operation status, errors, and results in bulk by action-attempt IDs or by device, returning one cursor-controlled page.

Input Parameters

integer
Maximum action attempts to return in this page.
string
Device UUID to filter action attempts by.
string
Opaque next-page cursor returned by a previous call.
array
Action-attempt UUIDs to inspect together. Use these to poll statuses returned by prior mutations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_LIST_CONNECTED_ACCOUNTSList and search provider accounts connected to the workspace, optionally filtering by space, customer, user, or metadata; returns one cursor-controlled page.

Input Parameters

integer
Maximum connected accounts to return in this page; must be greater than zero.
Partial match across account ID or type, customer key, metadata, username, email, or phone.
string
Space UUID to filter connected accounts by.
string
Opaque next-page cursor returned by a previous call.
string
Customer key to filter connected accounts by.
object
Metadata key-value pairs that each returned connected account must contain. Values may be strings or booleans.
string
Internal user identifier key to filter connected accounts by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_LIST_DEVICESList 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

integer
Maximum devices to return in this page. Seam documents no verified upper bound.
string
Partial match across device ID, account ID, display name, metadata, or location. UUID prefixes must be at least 4 characters.
string
Space UUID to filter by.
array
Device UUIDs to retrieve.
string
Single Seam device type key to filter by.
string
Opaque next-page cursor returned by a previous call.
string
Customer key to filter by.
array
Seam device type keys to filter by. Do not combine with device_type.
string
Documented Seam manufacturer key to filter by.
string
ISO 8601 timestamp; return devices created before it.
string
Connect Webview UUID to filter by.
object
Metadata key/value pairs that returned devices must contain.
string
Your internal user identifier key to filter by.
string
Connected account UUID to filter by.
array
Connected account UUIDs to filter by. Do not combine with connected_account_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_LIST_SPACESList and search spaces in the workspace by name, key, or customer, returning one cursor-controlled page of grantable locations.

Input Parameters

integer
Maximum spaces to return in this page. Seam documents no verified upper bound.
string
Partial match across space name, space key, or customer key.
string
Exact unique space key to filter by.
string
Opaque next-page cursor returned by a previous call.
string
Customer key to filter spaces by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SEAM_UPDATE_ACCESS_GRANTUpdate 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

string
New display name; null clears the name. At least one update field is required across name, starts_at, and 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.
string
New ISO 8601 start time. At least one update field is required across name, starts_at, and ends_at.
string
Grant UUID. Leave unset when identifying the grant by key; do not send both identifiers.
string
Grant key. Leave unset when identifying the grant by UUID; do not send both identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not