{ "openapi": "3.0.0", "info": { "title": "Seam Connect", "version": "1.0.0" }, "servers": [ { "url": "https://connect.getseam.com" } ], "components": { "schemas": { "access_code": { "description": "Represents a smart lock [access code](/low-level-apis/smart-locks/access-codes). See the [access_code object](/api/access_codes/object).", "properties": { "access_code_id": { "description": "Unique identifier for the access code.", "format": "uuid", "type": "string" }, "code": { "description": "Code used for access. Typically, a numeric or alphanumeric string.", "nullable": true, "type": "string" }, "common_code_key": { "description": "Unique identifier for a group of access codes that share the same code.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access code was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "Unique identifier for the device associated with the access code.", "format": "uuid", "type": "string" }, "dormakaba_oracode_metadata": { "description": "Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.", "nullable": true, "properties": { "is_cancellable": { "description": "Indicates whether the stay can be cancelled via the Dormakaba Oracode API.", "type": "boolean" }, "is_early_checkin_able": { "description": "Indicates whether early check-in is available for this stay.", "type": "boolean" }, "is_extendable": { "description": "Indicates whether the stay can be extended via the Dormakaba Oracode API.", "type": "boolean" }, "is_overridable": { "description": "Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.", "type": "boolean" }, "site_name": { "description": "Dormakaba Oracode site name associated with this access code.", "type": "string" }, "stay_id": { "description": "Dormakaba Oracode stay ID associated with this access code.", "format": "float", "type": "number" }, "user_level_id": { "description": "Dormakaba Oracode user level ID associated with this access code.", "type": "string" }, "user_level_name": { "description": "Dormakaba Oracode user level name associated with this access code.", "nullable": true, "type": "string" } }, "type": "object" }, "ends_at": { "description": "Date and time after which the time-bound access code becomes inactive.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "type": "array", "description": "Errors associated with the [access code](/low-level-apis/smart-locks/access-codes).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "is_backup": { "description": "Indicates whether the access code is a backup code.", "type": "boolean" }, "is_backup_access_code_available": { "description": "Indicates whether a backup access code is available for use if the primary access code is lost or compromised.", "type": "boolean" }, "is_external_modification_allowed": { "description": "Indicates whether changes to the access code from external sources are permitted.", "type": "boolean" }, "is_managed": { "description": "Indicates whether Seam manages the access code.", "enum": [ true ], "type": "boolean" }, "is_offline_access_code": { "description": "Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.", "type": "boolean" }, "is_scheduled_on_device": { "description": "Indicates whether the code is set on the device according to a preconfigured schedule.", "type": "boolean" }, "is_waiting_for_code_assignment": { "description": "Indicates whether the access code is waiting for a code assignment.", "type": "boolean" }, "name": { "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "nullable": true, "type": "string" }, "pending_mutations": { "description": "Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of setting an access code on the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of setting an access code on the device.", "enum": [ "creating" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is waiting until closer to the access code's start time before programming it on the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is waiting until closer to the access code's start time before programming it on the device.", "enum": [ "deferring_creation" ], "type": "string" }, "scheduled_at": { "description": "Date and time at which Seam will attempt to program this access code on the device.", "format": "date-time", "type": "string" } }, "required": [ "created_at", "message", "mutation_code", "scheduled_at" ], "type": "object" }, { "description": "Seam is in the process of removing an access code from the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of removing an access code from the device.", "enum": [ "deleting" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing an updated PIN code to the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous code configuration.", "properties": { "code": { "description": "Previous PIN code.", "nullable": true, "type": "string" } }, "required": [ "code" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device.", "enum": [ "updating_code" ], "type": "string" }, "to": { "description": "New code configuration.", "properties": { "code": { "description": "New PIN code.", "nullable": true, "type": "string" } }, "required": [ "code" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an updated access code name to the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous name configuration.", "properties": { "name": { "description": "Previous access code name.", "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device.", "enum": [ "updating_name" ], "type": "string" }, "to": { "description": "New name configuration.", "properties": { "name": { "description": "New access code name.", "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an updated time frame to the device.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous time frame configuration.", "properties": { "ends_at": { "description": "Previous end time for the access code.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for the access code.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device.", "enum": [ "updating_time_frame" ], "type": "string" }, "to": { "description": "New time frame configuration.", "properties": { "ends_at": { "description": "New end time for the access code.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for the access code.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "pulled_backup_access_code_id": { "description": "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.", "format": "uuid", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the time-bound access code becomes active.", "format": "date-time", "nullable": true, "type": "string" }, "status": { "description": "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).", "enum": [ "setting", "set", "unset", "removing", "unknown" ], "type": "string" }, "type": { "description": "Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.", "enum": [ "time_bound", "ongoing" ], "type": "string" }, "warnings": { "type": "array", "description": "Warnings associated with the [access code](/low-level-apis/smart-locks/access-codes).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "Unique identifier for the Seam workspace associated with the access code.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "common_code_key", "type", "access_code_id", "device_id", "name", "code", "created_at", "errors", "warnings", "is_managed", "status", "is_backup_access_code_available", "is_external_modification_allowed", "is_one_time_use", "is_offline_access_code", "pending_mutations" ], "type": "object", "x-route-path": "/access_codes" }, "access_grant": { "description": "Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. See the [access_grant object](/api/access_grants/object).", "properties": { "access_grant_id": { "description": "ID of the Access Grant.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Unique key for the access grant within the workspace.", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods created for the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "client_session_token": { "description": "Client Session Token. Only returned if the Access Grant has a mobile_key access method.", "type": "string" }, "created_at": { "description": "Date and time at which the Access Grant was created.", "format": "date-time", "type": "string" }, "customization_profile_id": { "description": "ID of the customization profile associated with the Access Grant.", "format": "uuid", "type": "string" }, "display_name": { "description": "Display name of the Access Grant.", "type": "string" }, "ends_at": { "description": "Date and time at which the Access Grant ends.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "description": "Errors associated with the [access grant](/use-cases/granting-access).", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam could not create one or more of the requested access methods for the access grant.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "cannot_create_requested_access_methods" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "access_grant" } ] }, "type": "array" }, "instant_key_url": { "description": "Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ", "format": "uri", "type": "string" }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", "nullable": true, "type": "string" }, "pending_mutations": { "description": "List of pending mutations for the access grant. This shows updates that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of updating the devices/spaces associated with this access grant.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous location configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access codes existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.", "enum": [ "updating_spaces" ], "type": "string" }, "to": { "description": "New location configuration.", "properties": { "common_code_key": { "description": "Common code key to ensure PIN code reuse across devices.", "nullable": true, "type": "string" }, "device_ids": { "description": "New device IDs where access codes should be created.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access grant.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "type": "object" } ] }, "type": "array" }, "requested_access_methods": { "description": "Access methods that the user requested for the Access Grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "created_access_method_ids": { "description": "IDs of the access methods created for the requested access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the requested access method was added to the Access Grant.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "IDs of the spaces to which the Access Grant gives access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the Access Grant starts.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of user identity to which the Access Grant gives access.", "format": "uuid", "type": "string" }, "warnings": { "type": "array", "description": "Warnings associated with the [access grant](/use-cases/granting-access).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "ID of the Seam workspace associated with the Access Grant.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_grant_id", "user_identity_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "type": "object", "x-route-path": "/access_grants" }, "access_method": { "description": "Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. See the [access_method object](/api/access_methods/object).", "properties": { "access_method_id": { "description": "ID of the access method.", "format": "uuid", "type": "string" }, "client_session_token": { "description": "Token of the client session associated with the access method.", "type": "string" }, "code": { "description": "The actual PIN code for code access methods.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access method was created.", "format": "date-time", "type": "string" }, "customization_profile_id": { "description": "ID of the customization profile associated with the access method.", "format": "uuid", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_url": { "description": "URL of the Instant Key for mobile key access methods.", "format": "uri", "type": "string" }, "is_assignment_required": { "description": "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.", "type": "boolean" }, "is_encoding_required": { "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.", "type": "boolean" }, "is_issued": { "description": "Indicates whether the access method has been issued.", "type": "boolean" }, "is_ready_for_assignment": { "description": "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.", "type": "boolean" }, "is_ready_for_encoding": { "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the access method was issued.", "format": "date-time", "nullable": true, "type": "string" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "pending_mutations": { "description": "Pending mutations for the [access method](/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of provisioning access for this access method on new devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access was provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.", "enum": [ "provisioning_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access is being provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of revoking access for this access method from devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.", "enum": [ "revoking_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access should remain.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access method.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "items": { "description": "Warning associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access method](/use-cases/granting-access/creating-an-access-grant) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access method](/use-cases/granting-access/creating-an-access-grant) are being updated.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "original_access_method_id": { "description": "ID of the original access method from which this backup access method was split, if applicable.", "format": "uuid", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "pulled_backup_access_code" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the access method.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "type": "object", "x-route-path": "/access_methods" }, "acs_access_group": { "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. See the [acs_access_group object](/api/acs/access_groups/object).", "properties": { "access_group_type": { "deprecated": true, "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group", "avigilon_alta_group", "kisi_access_group" ], "type": "string", "description": "Deprecated. Use `external_type`." }, "access_group_type_display_name": { "deprecated": true, "type": "string", "description": "Deprecated. Use `external_type_display_name`." }, "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access group's access.", "properties": { "ends_at": { "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_access_group_id": { "description": "ID of the access group.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access control system that contains the access group.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account that contains the access group.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the access group was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the access group.", "type": "string" }, "errors": { "description": "Errors associated with the `acs_access_group`.", "items": { "description": "Error associated with the `acs_access_group`.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that the [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "failed_to_create_on_acs_system" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "acs_access_group" } ] }, "type": "array" }, "external_type": { "description": "Brand-specific terminology for the access group type.", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group", "avigilon_alta_group", "kisi_access_group" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the access group type.", "type": "string" }, "is_managed": { "description": "Indicates whether Seam manages the access group.", "enum": [ true ], "type": "boolean" }, "name": { "description": "Name of the access group.", "type": "string" }, "pending_mutations": { "description": "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of pushing an access group creation to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.", "enum": [ "creating" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group deletion to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.", "enum": [ "deleting" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "This access group is scheduled for automatic deletion when its access window expires.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.", "enum": [ "deferring_deletion" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group information update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access group information.", "properties": { "name": { "description": "Name of the access group.", "nullable": true, "type": "string" } }, "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.", "enum": [ "updating_group_information" ], "type": "string" }, "to": { "description": "New access group information.", "properties": { "name": { "description": "Name of the access group.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access schedule update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access schedule information.", "properties": { "ends_at": { "description": "Ending time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.", "enum": [ "updating_access_schedule" ], "type": "string" }, "to": { "description": "New access schedule information.", "properties": { "ends_at": { "description": "Ending time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing a user membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old user membership.", "properties": { "acs_user_id": { "description": "Old user ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.", "enum": [ "updating_user_membership" ], "type": "string" }, "to": { "description": "New user membership.", "properties": { "acs_user_id": { "description": "New user ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an entrance membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old entrance membership.", "properties": { "acs_entrance_id": { "description": "Old entrance ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.", "enum": [ "updating_entrance_membership" ], "type": "string" }, "to": { "description": "New entrance membership.", "properties": { "acs_entrance_id": { "description": "New entrance ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "A scheduled user membership change is pending for this access group.", "properties": { "acs_user_id": { "description": "ID of the user involved in the scheduled change.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that a scheduled user membership change is pending for this access group.", "enum": [ "deferring_user_membership_update" ], "type": "string" }, "variant": { "description": "Whether the user is scheduled to be added to or removed from this access group.", "enum": [ "adding", "removing" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code", "acs_user_id", "variant" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the `acs_access_group`.", "items": { "description": "Warning associated with the `acs_access_group`.", "oneOf": [ { "description": "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "unknown_issue_with_acs_access_group" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the access group.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id", "acs_system_id", "workspace_id", "connected_account_id", "name", "access_group_type", "access_group_type_display_name", "display_name", "external_type", "external_type_display_name", "created_at", "errors", "warnings", "pending_mutations", "is_managed" ], "type": "object", "x-route-path": "/acs/access_groups" }, "acs_credential": { "description": "Means by which an [access control system user](/low-level-apis/access-systems/user-management) gains access at an [entrance](/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](/low-level-apis/access-systems). See the [acs_credential object](/api/acs/credentials/object).", "properties": { "access_method": { "description": "Access method for the [credential](/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "acs_credential_id": { "description": "ID of the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "acs_credential_pool_id": { "description": "ID of the credential pool to which the credential belongs.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the [ACS user](/low-level-apis/access-systems/user-management) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "assa_abloy_vostio_metadata": { "description": "Vostio-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "door_names": { "description": "Names of the doors to which to grant access in the Vostio access system.", "items": { "type": "string" }, "type": "array" }, "endpoint_id": { "description": "Endpoint ID in the Vostio access system.", "type": "string" }, "key_id": { "description": "Key ID in the Vostio access system.", "type": "string" }, "key_issuing_request_id": { "description": "Key issuing request ID in the Vostio access system.", "type": "string" }, "override_guest_acs_entrance_ids": { "description": "IDs of the guest entrances to override in the Vostio access system.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "card_number": { "description": "Number of the card associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "code": { "description": "Access (PIN) code for the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "connected_account_id": { "description": "ID of the [connected account](/core-concepts/connected-accounts) to which the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name that corresponds to the [credential](/low-level-apis/access-systems/managing-credentials) type.", "minLength": 1, "type": "string" }, "ends_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "errors": { "description": "Errors associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "external_type": { "description": "Brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", "enum": [ "pti_card", "brivo_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card", "salto_ks_tag", "avigilon_alta_credential", "kisi_credential" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type.", "type": "string" }, "is_issued": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.", "type": "boolean" }, "is_latest_desired_state_synced_with_provider": { "description": "Indicates whether the latest state of the [credential](/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.", "nullable": true, "type": "boolean" }, "is_managed": { "description": "Indicates whether Seam manages the credential.", "enum": [ true ], "type": "boolean" }, "is_multi_phone_sync_credential": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was encoded onto a card.", "format": "date-time", "nullable": true, "type": "string" }, "latest_desired_state_synced_with_provider_at": { "description": "Date and time at which the state of the [credential](/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.", "format": "date-time", "nullable": true, "type": "string" }, "parent_acs_credential_id": { "description": "ID of the parent [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "starts_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/api/user_identities/object) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "visionline_metadata": { "description": "Visionline-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "card_function_type": { "description": "Card function type in the Visionline access system.", "enum": [ "guest", "staff" ], "type": "string" }, "card_id": { "description": "ID of the card in the Visionline access system.", "type": "string" }, "common_acs_entrance_ids": { "description": "Common entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "credential_id": { "description": "ID of the credential in the Visionline access system.", "type": "string" }, "guest_acs_entrance_ids": { "description": "Guest entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_valid": { "description": "Indicates whether the credential is valid.", "type": "boolean" }, "joiner_acs_credential_ids": { "description": "IDs of the credentials to which you want to join.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "warnings": { "type": "array", "description": "Warnings associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "ID of the workspace that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "type": "object", "x-route-path": "/acs/credentials" }, "acs_credential_pool": { "deprecated": true, "properties": { "acs_credential_pool_id": { "format": "uuid", "type": "string" }, "acs_system_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "display_name": { "minLength": 1, "type": "string" }, "external_type": { "enum": [ "hid_part_number" ], "type": "string" }, "external_type_display_name": { "type": "string" }, "workspace_id": { "format": "uuid", "type": "string" } }, "required": [ "acs_credential_pool_id", "acs_system_id", "display_name", "external_type", "external_type_display_name", "created_at", "workspace_id" ], "type": "object", "x-route-path": "/acs/credential_pools", "description": "Deprecated. Not used." }, "acs_credential_provisioning_automation": { "deprecated": true, "properties": { "acs_credential_provisioning_automation_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "credential_manager_acs_system_id": { "format": "uuid", "type": "string" }, "user_identity_id": { "format": "uuid", "type": "string" }, "workspace_id": { "format": "uuid", "type": "string" } }, "required": [ "acs_credential_provisioning_automation_id", "credential_manager_acs_system_id", "user_identity_id", "created_at", "workspace_id" ], "type": "object", "x-route-path": "/acs/credential_provisioning_automations", "description": "Deprecated. Not used." }, "acs_encoder": { "description": "Represents a hardware device that encodes [credential](/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](/low-level-apis/access-systems). See the [acs_encoder object](/api/acs/encoders/object).", "properties": { "acs_encoder_id": { "description": "ID of the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account that contains the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "type": "string" }, "errors": { "description": "Errors associated with the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "items": { "description": "Error associated with the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "acs_encoder_removed" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "acs_encoder" }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "format": "uuid", "type": "string" } }, "required": [ "acs_encoder_id", "acs_system_id", "connected_account_id", "workspace_id", "errors", "created_at", "display_name" ], "type": "object", "x-route-path": "/acs/encoders" }, "acs_entrance": { "description": "Represents an [entrance](/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](/low-level-apis/access-systems). See the [acs_entrance object](/api/acs/entrances/object).", "properties": { "acs_entrance_id": { "description": "ID of the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "assa_abloy_vostio_metadata": { "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "door_name": { "description": "Name of the door in the Vostio access system.", "type": "string" }, "door_number": { "description": "Number of the door in the Vostio access system.", "format": "float", "type": "number" }, "door_type": { "description": "Type of the door in the Vostio access system.", "enum": [ "CommonDoor", "EntranceDoor", "GuestDoor", "Elevator" ], "type": "string" }, "pms_id": { "description": "PMS ID of the door in the Vostio access system.", "type": "string" }, "stand_open": { "description": "Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.", "type": "boolean" } }, "type": "object" }, "avigilon_alta_metadata": { "description": "Avigilon Alta-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "entry_name": { "description": "Entry name for an Avigilon Alta system.", "type": "string" }, "entry_relays_total_count": { "description": "Total count of entry relays for an Avigilon Alta system.", "format": "float", "type": "number" }, "org_name": { "description": "Organization name for an Avigilon Alta system.", "type": "string" }, "site_id": { "description": "Site ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "site_name": { "description": "Site name for an Avigilon Alta system.", "type": "string" }, "zone_id": { "description": "Zone ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "zone_name": { "description": "Zone name for an Avigilon Alta system.", "type": "string" } }, "type": "object" }, "brivo_metadata": { "description": "Brivo-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_id": { "description": "ID of the access point in the Brivo access system.", "type": "string" }, "site_id": { "description": "ID of the site that the access point belongs to.", "format": "float", "type": "number" }, "site_name": { "description": "Name of the site that the access point belongs to.", "type": "string" } }, "type": "object" }, "can_belong_to_reservation": { "description": "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.", "type": "boolean" }, "can_unlock_with_card": { "description": "Indicates whether the ACS entrance can be unlocked with card credentials.", "type": "boolean" }, "can_unlock_with_cloud_key": { "description": "Indicates whether the ACS entrance can be unlocked with cloud key credentials.", "type": "boolean" }, "can_unlock_with_code": { "description": "Indicates whether the ACS entrance can be unlocked with pin codes.", "type": "boolean" }, "can_unlock_with_mobile_key": { "description": "Indicates whether the ACS entrance can be unlocked with mobile key credentials.", "type": "boolean" }, "connected_account_id": { "description": "ID of the [connected account](/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [entrance](/low-level-apis/access-systems/retrieving-entrance-details) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "type": "string" }, "dormakaba_ambiance_metadata": { "description": "dormakaba Ambiance-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_name": { "description": "Name of the access point in the dormakaba Ambiance access system.", "type": "string" } }, "type": "object" }, "dormakaba_community_metadata": { "description": "dormakaba Community-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_profile": { "description": "Type of access point profile in the dormakaba Community access system.", "type": "string" } }, "type": "object" }, "errors": { "description": "Errors associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "items": { "properties": { "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "hotek_metadata": { "description": "Hotek-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "common_area_name": { "description": "Display name of the entrance.", "type": "string" }, "common_area_number": { "description": "Display name of the entrance.", "type": "string" }, "room_number": { "description": "Room number of the entrance.", "type": "string" } }, "type": "object" }, "is_locked": { "description": "Indicates whether the [entrance](/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.", "type": "boolean" }, "latch_metadata": { "description": "Latch-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "accessibility_type": { "description": "Accessibility type in the Latch access system.", "type": "string" }, "door_name": { "description": "Name of the door in the Latch access system.", "type": "string" }, "door_type": { "description": "Type of the door in the Latch access system.", "type": "string" }, "is_connected": { "description": "Indicates whether the entrance is connected.", "type": "boolean" } }, "type": "object" }, "salto_ks_metadata": { "description": "Salto KS-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "battery_level": { "description": "Battery level of the door access device.", "type": "string" }, "door_name": { "description": "Name of the door in the Salto KS access system.", "type": "string" }, "intrusion_alarm": { "description": "Indicates whether an intrusion alarm is active on the door.", "type": "boolean" }, "left_open_alarm": { "description": "Indicates whether the door is left open.", "type": "boolean" }, "lock_type": { "description": "Type of the lock in the Salto KS access system.", "type": "string" }, "locked_state": { "description": "Locked state of the door in the Salto KS access system.", "type": "string" }, "online": { "description": "Indicates whether the door access device is online.", "type": "boolean" }, "privacy_mode": { "description": "Indicates whether privacy mode is enabled for the lock.", "type": "boolean" } }, "type": "object" }, "salto_space_metadata": { "description": "Salto Space-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "audit_on_keys": { "description": "Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.", "type": "boolean" }, "door_description": { "description": "Description of the door in the Salto Space access system.", "type": "string" }, "door_id": { "description": "Door ID in the Salto Space access system.", "type": "string" }, "door_name": { "description": "Name of the door in the Salto Space access system.", "type": "string" }, "room_description": { "description": "Description of the room in the Salto Space access system.", "type": "string" }, "room_name": { "description": "Name of the room in the Salto Space access system.", "type": "string" } }, "type": "object" }, "space_ids": { "description": "IDs of the spaces that the entrance is in.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "visionline_metadata": { "description": "Visionline-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "door_category": { "description": "Category of the door in the Visionline access system.", "enum": [ "entrance", "guest", "elevator reader", "common", "common (PMS)" ], "type": "string" }, "door_name": { "description": "Name of the door in the Visionline access system.", "type": "string" }, "profiles": { "description": "Profile for the door in the Visionline access system.", "items": { "properties": { "visionline_door_profile_id": { "description": "Door profile ID in the Visionline access system.", "type": "string" }, "visionline_door_profile_type": { "description": "Door profile type in the Visionline access system.", "enum": [ "BLE", "commonDoor", "touch" ], "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "warnings": { "type": "array", "description": "Warnings associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } } }, "required": [ "acs_system_id", "acs_entrance_id", "space_ids", "created_at", "display_name", "connected_account_id", "errors", "warnings" ], "type": "object", "x-route-path": "/acs/entrances" }, "acs_system": { "description": "Represents an [access control system](/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](/api/acs/users/object) and [`acs_credential`s](/api/acs/credentials/object) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](/api/acs/object). See the [acs_system object](/api/acs/systems/object).", "properties": { "acs_access_group_count": { "description": "Number of access groups in the [access control system](/low-level-apis/access-systems).", "format": "float", "type": "number" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems).", "format": "uuid", "type": "string" }, "acs_user_count": { "description": "Number of users in the [access control system](/low-level-apis/access-systems).", "format": "float", "type": "number" }, "connected_account_id": { "description": "ID of the connected account associated with the [access control system](/low-level-apis/access-systems).", "format": "uuid", "type": "string" }, "connected_account_ids": { "deprecated": true, "description": "Deprecated. Use `connected_account_id`.\n\nIDs of the [connected accounts](/core-concepts/connected-accounts) associated with the [access control system](/low-level-apis/access-systems).", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the [access control system](/low-level-apis/access-systems) was created.", "format": "date-time", "type": "string" }, "default_credential_manager_acs_system_id": { "description": "ID of the default credential manager `acs_system` for this [access control system](/low-level-apis/access-systems).", "format": "uuid", "nullable": true, "type": "string" }, "errors": { "type": "array", "description": "Errors associated with the [access control system](/low-level-apis/access-systems).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "external_type": { "description": "Brand-specific terminology for the [access control system](/low-level-apis/access-systems) type.", "enum": [ "pti_site", "avigilon_alta_org", "salto_ks_site", "salto_space_system", "brivo_account", "hid_credential_manager_organization", "visionline_system", "assa_abloy_credential_service", "latch_building", "dormakaba_community_site", "dormakaba_ambiance_site", "legic_connect_credential_service", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "hotek_site", "kisi_organization" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [access control system](/low-level-apis/access-systems) type.", "type": "string" }, "image_alt_text": { "description": "Alternative text for the [access control system](/low-level-apis/access-systems) image.", "type": "string" }, "image_url": { "description": "URL for the image that represents the [access control system](/low-level-apis/access-systems).", "type": "string" }, "is_credential_manager": { "description": "Indicates whether the `acs_system` is a credential manager.", "type": "boolean" }, "location": { "description": "Location information for the [access control system](/low-level-apis/access-systems).", "properties": { "time_zone": { "description": "Time zone in which the [access control system](/low-level-apis/access-systems) is located.", "nullable": true, "type": "string" } }, "required": [ "time_zone" ], "type": "object" }, "name": { "description": "Name of the [access control system](/low-level-apis/access-systems).", "type": "string" }, "system_type": { "deprecated": true, "enum": [ "pti_site", "avigilon_alta_org", "salto_ks_site", "salto_space_system", "brivo_account", "hid_credential_manager_organization", "visionline_system", "assa_abloy_credential_service", "latch_building", "dormakaba_community_site", "dormakaba_ambiance_site", "legic_connect_credential_service", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "hotek_site", "kisi_organization" ], "type": "string", "description": "Deprecated. Use `external_type`." }, "system_type_display_name": { "deprecated": true, "type": "string", "description": "Deprecated. Use `external_type_display_name`." }, "visionline_metadata": { "description": "Visionline-specific metadata for the [access control system](/low-level-apis/access-systems).", "properties": { "lan_address": { "description": "IP address or hostname of the main Visionline server relative to [Seam Bridge](/capability-guides/seam-bridge) on the local network.", "type": "string" }, "mobile_access_uuid": { "description": "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.", "type": "string" }, "system_id": { "description": "Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.", "type": "string" } }, "type": "object" }, "warnings": { "description": "Warnings associated with the [access control system](/low-level-apis/access-systems).", "items": { "description": "Warning associated with the [access control system](/low-level-apis/access-systems).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "salto_ks_subscription_limit_almost_reached" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates the [access control system](/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "misconfigured_acs_entrance_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. this field is deprecated." }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "time_zone_does_not_match_location" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "setup_required" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the [access control system](/low-level-apis/access-systems).", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id", "is_credential_manager", "location", "name", "created_at", "workspace_id", "connected_account_ids", "connected_account_id", "image_url", "image_alt_text", "errors", "warnings" ], "type": "object", "x-route-path": "/acs/systems" }, "acs_user": { "description": "Represents a [user](/low-level-apis/access-systems/user-management) in an [access system](/low-level-apis/access-systems). See the [acs_user object](/api/acs/users/object).", "properties": { "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the [access system user's](/low-level-apis/access-systems/user-management) access.", "properties": { "ends_at": { "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_system_id": { "description": "ID of the [access system](/low-level-apis/access-systems) that contains the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "\n The ID of the connected account that is associated with the [access system user](/low-level-apis/access-systems/user-management).\n ", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [access system user](/low-level-apis/access-systems/user-management) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the [access system user](/low-level-apis/access-systems/user-management).", "type": "string" }, "email": { "deprecated": true, "format": "email", "type": "string", "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", "format": "email", "type": "string" }, "errors": { "type": "array", "description": "Errors associated with the [access system user](/low-level-apis/access-systems/user-management).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "external_type": { "description": "Brand-specific terminology for the [access system user](/low-level-apis/access-systems/user-management) type.", "enum": [ "pti_user", "brivo_user", "hid_credential_manager_user", "salto_site_user", "latch_user", "dormakaba_community_user", "salto_space_user", "avigilon_alta_user", "kisi_user" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [access system user](/low-level-apis/access-systems/user-management) type.", "type": "string" }, "full_name": { "description": "Full name of the [access system user](/low-level-apis/access-systems/user-management).", "minLength": 1, "type": "string" }, "hid_acs_system_id": { "description": "ID of the HID access control system associated with the user.", "format": "uuid", "type": "string" }, "is_managed": { "description": "Indicates whether Seam manages the access system user.", "enum": [ true ], "type": "boolean" }, "is_suspended": { "description": "Indicates whether the [access system user](/low-level-apis/access-systems/user-management) is currently [suspended](/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).", "type": "boolean" }, "pending_mutations": { "description": "Pending mutations associated with the [access system user](/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of pushing a user creation to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.", "enum": [ "creating" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing a user deletion to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.", "enum": [ "deleting" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time.", "enum": [ "deferring_creation" ], "type": "string" }, "scheduled_at": { "description": "Optional: When the user creation is scheduled to occur.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access system user information.", "properties": { "email_address": { "description": "Email address of the access system user.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the access system user.", "nullable": true, "type": "string" }, "phone_number": { "description": "Phone number of the access system user.", "nullable": true, "type": "string" } }, "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.", "enum": [ "updating_user_information" ], "type": "string" }, "to": { "description": "New access system user information.", "properties": { "email_address": { "description": "Email address of the access system user.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the access system user.", "nullable": true, "type": "string" }, "phone_number": { "description": "Phone number of the access system user.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access schedule update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access schedule information.", "properties": { "ends_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.", "enum": [ "updating_access_schedule" ], "type": "string" }, "to": { "description": "New access schedule information.", "properties": { "ends_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing a suspension state update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old user suspension state information.", "properties": { "is_suspended": { "type": "boolean" } }, "required": [ "is_suspended" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.", "enum": [ "updating_suspension_state" ], "type": "string" }, "to": { "description": "New user suspension state information.", "properties": { "is_suspended": { "type": "boolean" } }, "required": [ "is_suspended" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access group membership.", "properties": { "acs_access_group_id": { "description": "Old access group ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.", "enum": [ "updating_group_membership" ], "type": "string" }, "to": { "description": "New access group membership.", "properties": { "acs_access_group_id": { "description": "New access group ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "A scheduled access group membership change is pending for this user.", "properties": { "acs_access_group_id": { "description": "ID of the access group involved in the scheduled change.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that a scheduled access group membership change is pending for this user.", "enum": [ "deferring_group_membership_update" ], "type": "string" }, "variant": { "description": "Whether the user is scheduled to be added to or removed from the access group.", "enum": [ "adding", "removing" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code", "acs_access_group_id", "variant" ], "type": "object" }, { "description": "Seam is in the process of assigning or unassigning a credential to the user on the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous credential assignment.", "properties": { "acs_credential_id": { "description": "Previous credential ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of assigning or unassigning a credential to the user on the integrated access system.", "enum": [ "updating_credential_assignment" ], "type": "string" }, "to": { "description": "New credential assignment.", "properties": { "acs_credential_id": { "description": "New credential ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "phone_number": { "description": "Phone number of the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "type": "string" }, "salto_space_metadata": { "description": "Salto Space-specific metadata associated with the [access system user](/low-level-apis/access-systems/user-management).", "properties": { "audit_openings": { "description": "Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.", "type": "boolean" }, "user_id": { "description": "User ID in the Salto Space access system.", "type": "string" } }, "type": "object" }, "user_identity_email_address": { "description": "Email address of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "nullable": true, "type": "string" }, "user_identity_full_name": { "description": "Full name of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "type": "string" }, "user_identity_phone_number": { "description": "Phone number of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "nullable": true, "type": "string" }, "warnings": { "description": "Warnings associated with the [access system user](/low-level-apis/access-systems/user-management).", "items": { "description": "Warnings associated with the [access system user](/low-level-apis/access-systems/user-management).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) is being deleted from the [access system](/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "salto_ks_user_not_subscribed" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "An unknown issue occurred while syncing the state of this [access system user](/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "unknown_issue_with_acs_user" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "latch_resident_user" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id", "acs_system_id", "workspace_id", "created_at", "display_name", "warnings", "errors", "connected_account_id", "is_managed" ], "type": "object", "x-route-path": "/acs/users" }, "action_attempt": { "description": "Represents an asynchronous action. Poll until status is success or error. See the [action_attempt object](/api/action_attempts/object).", "x-route-path": "/action_attempts", "type": "object", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] }, "batch": { "description": "A batch of workspace resources.", "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/access_code" }, "type": "array" }, "access_grants": { "items": { "$ref": "#/components/schemas/access_grant" }, "type": "array" }, "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_access_groups": { "items": { "$ref": "#/components/schemas/acs_access_group" }, "type": "array" }, "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "acs_encoders": { "items": { "$ref": "#/components/schemas/acs_encoder" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" }, "action_attempts": { "items": { "$ref": "#/components/schemas/action_attempt" }, "type": "array" }, "client_sessions": { "items": { "$ref": "#/components/schemas/client_session" }, "type": "array" }, "connect_webviews": { "items": { "$ref": "#/components/schemas/connect_webview" }, "type": "array" }, "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "customization_profiles": { "items": { "$ref": "#/components/schemas/customization_profile" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "events": { "items": { "$ref": "#/components/schemas/event" }, "type": "array" }, "instant_keys": { "items": { "$ref": "#/components/schemas/instant_key" }, "type": "array" }, "noise_thresholds": { "items": { "$ref": "#/components/schemas/noise_threshold" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" }, "thermostat_daily_programs": { "items": { "$ref": "#/components/schemas/thermostat_daily_program" }, "type": "array" }, "thermostat_schedules": { "items": { "$ref": "#/components/schemas/thermostat_schedule" }, "type": "array" }, "unmanaged_access_codes": { "items": { "$ref": "#/components/schemas/unmanaged_access_code" }, "type": "array" }, "unmanaged_acs_access_groups": { "items": { "$ref": "#/components/schemas/unmanaged_acs_access_group" }, "type": "array" }, "unmanaged_acs_credentials": { "items": { "$ref": "#/components/schemas/unmanaged_acs_credential" }, "type": "array" }, "unmanaged_acs_users": { "items": { "$ref": "#/components/schemas/unmanaged_acs_user" }, "type": "array" }, "unmanaged_devices": { "items": { "$ref": "#/components/schemas/unmanaged_device" }, "type": "array" }, "user_identities": { "items": { "$ref": "#/components/schemas/user_identity" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/workspace" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" }, "bridge_client_session": { "description": "Represents a [Seam Bridge](/capability-guides/seam-bridge) client session.", "properties": { "bridge_client_machine_identifier_key": { "description": "Identifier key of the client machine for the Seam Bridge client.", "type": "string" }, "bridge_client_name": { "description": "Name of the Seam Bridge client.", "type": "string" }, "bridge_client_session_id": { "description": "ID of the Seam Bridge client session.", "format": "uuid", "type": "string" }, "bridge_client_session_token": { "description": "Client session token associated with the Seam Bridge client session.", "type": "string" }, "bridge_client_time_zone": { "description": "Time zone for the Seam Bridge client.", "type": "string" }, "created_at": { "description": "Date and time at which the Seam Bridge client session was created.", "format": "date-time", "type": "string" }, "errors": { "description": "Errors associated with the Seam Bridge client session.", "items": { "description": "Indicates an error associated with the Seam Bridge client session.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam cannot reach Seam Bridge's LAN.", "properties": { "can_tailscale_proxy_reach_bridge": { "description": "Indicates whether the Tailscale proxy can reach Seam Bridge.", "nullable": true, "type": "boolean" }, "can_tailscale_proxy_reach_tailscale_network": { "description": "Indicates whether the Tailscale proxy can reach the Tailscale network.", "nullable": true, "type": "boolean" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "bridge_lan_unreachable" ], "type": "string" }, "is_bridge_socks_server_healthy": { "description": "Indicates whether Seam Bridge's SOCKS server is healthy.", "nullable": true, "type": "boolean" }, "is_tailscale_proxy_reachable": { "description": "Indicates whether Seam can reach the Tailscale proxy.", "nullable": true, "type": "boolean" }, "is_tailscale_proxy_socks_server_healthy": { "description": "Indicates whether the Tailscale proxy's SOCKS server is healthy.", "nullable": true, "type": "boolean" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "message", "created_at", "error_code", "is_tailscale_proxy_reachable", "is_tailscale_proxy_socks_server_healthy", "can_tailscale_proxy_reach_tailscale_network", "can_tailscale_proxy_reach_bridge", "is_bridge_socks_server_healthy" ], "type": "object", "x-resource-type": "bridge_client_session" }, { "description": "Indicates that Seam Bridge has stopped communicating with Seam.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "no_communication_from_bridge" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "message", "created_at", "error_code" ], "type": "object", "x-resource-type": "bridge_client_session" } ] }, "type": "array" }, "pairing_code": { "description": "Pairing code for Seam Bridge. Use this code to pair Seam Bridge with your workspace.", "maxLength": 6, "minLength": 6, "type": "string" }, "pairing_code_expires_at": { "description": "Date and time at which the pairing code expires.", "format": "date-time", "type": "string" }, "tailscale_auth_key": { "description": "Tailscale authorization key for Seam Bridge.", "nullable": true, "type": "string" }, "tailscale_hostname": { "description": "Tailscale hostname for Seam Bridge.", "type": "string" }, "telemetry_token": { "description": "Telemetry token for the Seam Bridge client session.", "nullable": true, "type": "string" }, "telemetry_token_expires_at": { "description": "Date and time at which the telemetry token for the Seam Bridge client session expires.", "format": "date-time", "nullable": true, "type": "string" }, "telemetry_url": { "description": "Telemetry URL for the Seam Bridge client session.", "nullable": true, "type": "string" } }, "required": [ "created_at", "bridge_client_session_id", "bridge_client_session_token", "pairing_code", "pairing_code_expires_at", "tailscale_hostname", "tailscale_auth_key", "bridge_client_name", "bridge_client_time_zone", "bridge_client_machine_identifier_key", "errors", "telemetry_token", "telemetry_token_expires_at", "telemetry_url" ], "type": "object", "x-route-path": "/seam/bridge/v1/bridge_client_sessions" }, "bridge_connected_systems": { "description": "Represents an access system connected to [Seam Bridge](/capability-guides/seam-bridge).", "properties": { "acs_system_display_name": { "description": "Display name for the [access system](/low-level-apis/access-systems) associated with Seam Bridge.", "type": "string" }, "acs_system_id": { "description": "ID of the [access system](/low-level-apis/access-systems) associated with Seam Bridge.", "format": "uuid", "type": "string" }, "bridge_created_at": { "description": "Date and time at which Seam Bridge was created.", "format": "date-time", "type": "string" }, "bridge_id": { "description": "ID of Seam Bridge connected to the access system.", "format": "uuid", "type": "string" }, "connected_account_created_at": { "description": "Date and time at which the connected account associated with Seam Bridge was created.", "format": "date-time", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with Seam Bridge.", "format": "uuid", "type": "string" }, "workspace_display_name": { "description": "Display name for the [workspace](/core-concepts/workspaces) with which Seam Bridge is paired.", "type": "string" }, "workspace_id": { "description": "ID of the workspace with which Seam Bridge is paired.", "format": "uuid", "type": "string" } }, "required": [ "bridge_id", "bridge_created_at", "connected_account_id", "connected_account_created_at", "acs_system_id", "acs_system_display_name", "workspace_id", "workspace_display_name" ], "type": "object", "x-route-path": "/seam/bridge/v1/bridge_connected_systems" }, "client_session": { "description": "Represents a [client session](/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. See the [client_session object](/api/client_sessions/object).", "properties": { "client_session_id": { "description": "ID of the client session.", "format": "uuid", "type": "string" }, "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) associated with the [client session](/core-concepts/authentication/client-session-tokens).", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) associated with the [client session](/core-concepts/authentication/client-session-tokens).", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the [client session](/core-concepts/authentication/client-session-tokens) was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "Customer key associated with the [client session](/core-concepts/authentication/client-session-tokens).", "type": "string" }, "device_count": { "description": "Number of devices associated with the [client session](/core-concepts/authentication/client-session-tokens).", "format": "float", "type": "number" }, "expires_at": { "description": "Date and time at which the [client session](/core-concepts/authentication/client-session-tokens) expires.", "format": "date-time", "type": "string" }, "token": { "description": "Client session token associated with the [client session](/core-concepts/authentication/client-session-tokens).", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user associated with the [client session](/core-concepts/authentication/client-session-tokens).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.", "format": "uuid", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "workspace_id": { "description": "ID of the workspace associated with the client session.", "format": "uuid", "type": "string" } }, "required": [ "client_session_id", "workspace_id", "created_at", "expires_at", "token", "user_identifier_key", "device_count", "connected_account_ids", "connect_webview_ids", "user_identity_ids" ], "type": "object", "x-route-path": "/client_sessions" }, "connect_webview": { "description": "Represents a [Connect Webview](/core-concepts/connect-webviews). See the [connect_webview object](/api/connect_webviews/object).", "properties": { "accepted_capabilities": { "description": "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.", "items": { "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "type": "string" }, "type": "array" }, "accepted_providers": { "description": "List of accepted [provider keys](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "items": { "type": "string" }, "type": "array" }, "any_provider_allowed": { "description": "Indicates whether any provider is allowed.", "type": "boolean" }, "authorized_at": { "description": "Date and time at which the user authorized (through the Connect Webview) the management of their devices.", "format": "date-time", "nullable": true, "type": "string" }, "automatically_manage_new_devices": { "description": "Indicates whether Seam should [import all new devices](/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.", "type": "boolean" }, "connect_webview_id": { "description": "ID of the Connect Webview.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the Connect Webview.", "format": "uuid", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the Connect Webview was created.", "format": "date-time", "type": "string" }, "custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "custom_redirect_failure_url": { "description": "URL to which the Connect Webview should redirect when an unexpected error occurs.", "format": "uri", "nullable": true, "type": "string" }, "custom_redirect_url": { "description": "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.", "format": "uri", "nullable": true, "type": "string" }, "customer_key": { "description": "The customer key associated with this webview, if any.", "type": "string" }, "device_selection_mode": { "description": "Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.", "enum": [ "none", "single", "multiple" ], "type": "string" }, "login_successful": { "description": "Indicates whether the user logged in successfully using the Connect Webview.", "type": "boolean" }, "selected_provider": { "description": "Selected provider of the Connect Webview, one of the [provider keys](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "nullable": true, "type": "string" }, "status": { "description": "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.", "enum": [ "pending", "failed", "authorized" ], "type": "string" }, "url": { "description": "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.", "format": "uri", "type": "string" }, "wait_for_device_creation": { "description": "Indicates whether Seam should [finish syncing all devices](/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.", "type": "boolean" }, "workspace_id": { "description": "ID of the workspace that contains the Connect Webview.", "format": "uuid", "type": "string" } }, "required": [ "connect_webview_id", "workspace_id", "created_at", "connected_account_id", "url", "device_selection_mode", "accepted_providers", "accepted_capabilities", "any_provider_allowed", "login_successful", "status", "custom_redirect_url", "custom_redirect_failure_url", "custom_metadata", "automatically_manage_new_devices", "wait_for_device_creation", "authorized_at", "selected_provider" ], "type": "object", "x-route-path": "/connect_webviews" }, "connected_account": { "description": "Represents a [connected account](/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. See the [connected_account object](/api/connected_accounts/object).", "properties": { "accepted_capabilities": { "description": "List of capabilities that were accepted during the account connection process.", "items": { "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "type": "string" }, "type": "array" }, "account_type": { "description": "Type of connected account.", "type": "string" }, "account_type_display_name": { "description": "Display name for the connected account type.", "type": "string" }, "automatically_manage_new_devices": { "description": "Indicates whether Seam should [import all new devices](/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.", "type": "boolean" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the connected account was created.", "format": "date-time", "type": "string" }, "custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "customer_key": { "description": "Your unique key for the customer associated with this connected account.", "type": "string" }, "default_checkin_time": { "description": "Default reservation check-in time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration — set during the connect_webview for providers like Lodgify whose API does not expose check-in times.", "type": "string" }, "default_checkout_time": { "description": "Default reservation check-out time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration.", "type": "string" }, "display_name": { "description": "Display name for the connected account.", "type": "string" }, "errors": { "description": "Errors associated with the connected account.", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that the account is disconnected.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "account_disconnected" ], "type": "string" }, "is_bridge_error": { "description": "Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).", "type": "boolean" }, "is_connected_account_error": { "description": "Indicates whether the error is related specifically to the connected account.", "type": "boolean" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "connected_account" }, { "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "bridge_disconnected" ], "type": "string" }, "is_bridge_error": { "description": "Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).", "type": "boolean" }, "is_connected_account_error": { "description": "Indicates whether the error is related specifically to the connected account.", "type": "boolean" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "connected_account" }, { "description": "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "salto_ks_subscription_limit_exceeded" ], "type": "string" }, "is_bridge_error": { "description": "Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).", "type": "boolean" }, "is_connected_account_error": { "description": "Indicates whether the error is related specifically to the connected account.", "type": "boolean" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "salto_ks_metadata": { "description": "Salto KS metadata associated with the connected account that has an error.", "properties": { "sites": { "description": "Salto sites associated with the connected account that has an error.", "items": { "description": "Salto site associated with the connected account that has an error.", "properties": { "site_id": { "description": "ID of a Salto site associated with the connected account that has an error.", "type": "string" }, "site_name": { "description": "Name of a Salto site associated with the connected account that has an error.", "type": "string" }, "site_user_subscription_limit": { "description": "Subscription limit of site users for a Salto site associated with the connected account that has an error.", "minimum": 0, "type": "integer" }, "subscribed_site_user_count": { "description": "Count of subscribed site users for a Salto site associated with the connected account that has an error.", "minimum": 0, "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "required": [ "created_at", "message", "error_code", "salto_ks_metadata" ], "type": "object", "x-resource-type": "connected_account" }, { "description": "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "dormakaba_sites_disconnected" ], "type": "string" }, "is_bridge_error": { "description": "Indicates whether the error is related to [Seam Bridge](/capability-guides/seam-bridge).", "type": "boolean" }, "is_connected_account_error": { "description": "Indicates whether the error is related specifically to the connected account.", "type": "boolean" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "connected_account" } ] }, "type": "array" }, "ical_feed_origin": { "description": "For iCal connected accounts, the platform that produced the feed (for example, `airbnb`, `vrbo`, or `booking`), or `unknown` when it could not be determined. Intended for rendering the source platform's logo.", "type": "string" }, "ical_url": { "description": "For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.", "type": "string" }, "image_url": { "description": "Logo URL for the connected account provider.", "format": "uri", "type": "string" }, "time_zone": { "description": "IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.", "type": "string" }, "user_identifier": { "deprecated": true, "description": "Deprecated. Use `display_name` instead.\n\nUser identifier associated with the connected account.", "properties": { "api_url": { "description": "API URL for the user identifier associated with the connected account.", "type": "string" }, "email": { "description": "Email address of the user identifier associated with the connected account.", "type": "string" }, "exclusive": { "description": "Indicates whether the user identifier associated with the connected account is exclusive.", "type": "boolean" }, "phone": { "description": "Phone number of the user identifier associated with the connected account.", "type": "string" }, "username": { "description": "Username of the user identifier associated with the connected account.", "type": "string" } }, "type": "object" }, "warnings": { "type": "array", "description": "Warnings associated with the connected account.", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } } }, "required": [ "connected_account_id", "account_type_display_name", "display_name", "errors", "warnings", "custom_metadata", "automatically_manage_new_devices", "accepted_capabilities" ], "type": "object", "x-route-path": "/connected_accounts" }, "customer": { "description": "Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more.", "properties": { "created_at": { "description": "Date and time at which the customer was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "Unique key for the customer within the workspace.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the customer.", "format": "uuid", "type": "string" } }, "required": [ "customer_key", "workspace_id", "created_at" ], "type": "object", "x-route-path": "/customers" }, "customer_portal": { "description": "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe. See the [customer_portal object](/api/customers/object).", "properties": { "created_at": { "description": "Date and time at which the customer portal link was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "Customer key for the customer portal.", "type": "string" }, "expires_at": { "description": "Date and time at which the customer portal link expires.", "format": "date-time", "type": "string" }, "url": { "description": "URL for the customer portal.", "format": "uri", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the customer portal.", "format": "uuid", "type": "string" } }, "required": [ "url", "customer_key", "expires_at", "workspace_id", "created_at" ], "type": "object", "x-route-path": "/customers" }, "customization_profile": { "description": "A customization profile.", "properties": { "created_at": { "format": "date-time", "type": "string" }, "customer_portal_theme": { "properties": { "font_family": { "type": "string" }, "mono_font_family": { "type": "string" }, "primary_color": { "type": "string" }, "primary_foreground_color": { "type": "string" }, "secondary_color": { "type": "string" }, "secondary_foreground_color": { "type": "string" } }, "type": "object" }, "customization_profile_id": { "format": "uuid", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "message_overrides": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "object" }, "name": { "nullable": true, "type": "string" }, "primary_color": { "type": "string" }, "secondary_color": { "type": "string" }, "workspace_id": { "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "name", "customization_profile_id", "created_at" ], "type": "object", "x-route-path": "/workspaces/customization_profiles", "x-title": "Customization Profile" }, "device": { "description": "Represents a [device](/core-concepts/devices) that has been connected to Seam. See the [device object](/api/devices/object).", "properties": { "can_configure_auto_lock": { "description": "Indicates whether the lock supports configuring automatic locking.", "type": "boolean" }, "can_hvac_cool": { "description": "Indicates whether the thermostat supports cooling.", "type": "boolean" }, "can_hvac_heat": { "description": "Indicates whether the thermostat supports heating.", "type": "boolean" }, "can_hvac_heat_cool": { "description": "Indicates whether the thermostat supports simultaneous heating and cooling.", "type": "boolean" }, "can_program_offline_access_codes": { "description": "Indicates whether the device supports programming offline access codes.", "type": "boolean" }, "can_program_online_access_codes": { "description": "Indicates whether the device supports programming online access codes.", "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "description": "Indicates whether the thermostat supports different climate programs for each day of the week.", "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "description": "Indicates whether the thermostat supports a single climate program applied to every day.", "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "description": "Indicates whether the thermostat supports weekday/weekend climate programs.", "type": "boolean" }, "can_remotely_lock": { "description": "Indicates whether the device supports remote locking.", "type": "boolean" }, "can_remotely_unlock": { "description": "Indicates whether the device supports remote unlocking.", "type": "boolean" }, "can_run_thermostat_programs": { "description": "Indicates whether the thermostat supports running climate programs.", "type": "boolean" }, "can_simulate_connection": { "description": "Indicates whether the device supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_disconnection": { "description": "Indicates whether the device supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_hub_connection": { "description": "Indicates whether the hub supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_hub_disconnection": { "description": "Indicates whether the hub supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_paid_subscription": { "description": "Indicates whether the device supports simulating a paid subscription in a sandbox.", "type": "boolean" }, "can_simulate_removal": { "description": "Indicates whether the device supports simulating removal in a sandbox.", "type": "boolean" }, "can_turn_off_hvac": { "description": "Indicates whether the thermostat can be turned off.", "type": "boolean" }, "can_unlock_with_code": { "description": "Indicates whether the lock supports unlocking with an access code.", "type": "boolean" }, "capabilities_supported": { "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](/capability-guides/device-and-system-capabilities#capability-flags).\n ", "items": { "description": "\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](/capability-guides/device-and-system-capabilities#capability-flags).\n ", "enum": [ "access_code", "lock", "noise_detection", "thermostat", "battery", "phone" ], "type": "string" }, "type": "array" }, "connected_account_id": { "description": "Unique identifier for the account associated with the device.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the device object was created.", "format": "date-time", "type": "string" }, "custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "device_id": { "description": "ID of the device.", "format": "uuid", "type": "string" }, "device_manufacturer": { "description": "Manufacturer of the device. Represents the hardware brand, which may differ from the provider.", "properties": { "display_name": { "description": "Display name for the manufacturer, such as `August`, `Yale`, `Salto`, and so on.", "type": "string" }, "image_url": { "description": "Image URL for the manufacturer logo.", "format": "uri", "type": "string" }, "manufacturer": { "description": "Manufacturer identifier, such as `august`, `yale`, `salto`, and so on.", "type": "string" } }, "required": [ "manufacturer", "display_name" ], "type": "object", "x-property-group-key": "hardware" }, "device_provider": { "description": "Provider of the device. Represents the third-party service through which the device is controlled.", "properties": { "device_provider_name": { "description": "Device provider name. Corresponds to the integration type, such as `august`, `schlage`, `yale_access`, and so on.", "type": "string" }, "display_name": { "description": "Display name for the device provider type.", "type": "string" }, "image_url": { "description": "Image URL for the device provider.", "format": "uri", "type": "string" }, "provider_category": { "description": "Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations.", "type": "string" } }, "required": [ "provider_category", "device_provider_name", "display_name" ], "type": "object", "x-property-group-key": "hardware" }, "device_type": { "description": "Type of the device.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "display_name": { "description": "Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.", "type": "string" }, "errors": { "type": "array", "description": "Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "is_managed": { "description": "Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](/core-concepts/devices/managed-and-unmanaged-devices).", "enum": [ true ], "type": "boolean" }, "location": { "description": "Location information for the device.", "properties": { "location_name": { "description": "Name of the device location.\n ", "type": "string" }, "time_zone": { "description": "Time zone of the device location.\n ", "type": "string" }, "timezone": { "deprecated": true, "description": "Deprecated. Use `time_zone` instead.\n\nTime zone of the device location.", "type": "string" } }, "type": "object", "x-property-group-key": "hardware" }, "nickname": { "description": "Optional nickname to describe the device, settable through Seam.", "type": "string" }, "properties": { "allOf": [ { "allOf": [ { "allOf": [ { "properties": { "accessory_keypad": { "description": "Accessory keypad properties and state.", "properties": { "battery": { "description": "Keypad battery properties.\n ", "properties": { "level": { "format": "float", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "level" ], "type": "object" }, "is_connected": { "description": "Indicates if an accessory keypad is connected to the device.\n ", "type": "boolean" } }, "required": [ "is_connected" ], "type": "object", "x-property-group-key": "hardware" }, "appearance": { "description": "Appearance-related properties, as reported by the device.", "properties": { "name": { "description": "Name of the device as seen from the provider API and application, not settable through Seam.", "type": "string" } }, "required": [ "name" ], "type": "object", "x-property-group-key": "hardware" }, "battery": { "description": "Represents the current status of the battery charge level.", "properties": { "level": { "description": "Battery charge level as a value between 0 and 1, inclusive.\n ", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "status": { "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ", "enum": [ "critical", "low", "good", "full" ], "type": "string" } }, "required": [ "level", "status" ], "type": "object", "x-property-group-key": "hardware" }, "battery_level": { "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", "format": "float", "maximum": 1, "minimum": 0, "type": "number", "x-property-group-key": "hardware" }, "currently_triggering_noise_threshold_ids": { "description": "Array of noise threshold IDs that are currently triggering.", "items": { "type": "string" }, "type": "array", "x-property-group-key": "noise_sensors" }, "has_direct_power": { "description": "Indicates whether the device has direct power.", "type": "boolean", "x-property-group-key": "hardware" }, "image_alt_text": { "description": "Alt text for the device image.", "type": "string", "x-property-group-key": "hardware" }, "image_url": { "description": "Image URL for the device.", "format": "uri", "type": "string", "x-property-group-key": "hardware" }, "manufacturer": { "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "type": "string", "x-property-group-key": "hardware" }, "model": { "description": "Device model-related properties.", "properties": { "accessory_keypad_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "can_connect_accessory_keypad": { "description": "\n Indicates whether the device can connect a accessory keypad.\n ", "type": "boolean" }, "display_name": { "description": "\n Display name of the device model.\n ", "type": "string" }, "has_built_in_keypad": { "description": "\n Indicates whether the device has a built in accessory keypad.\n ", "type": "boolean" }, "manufacturer_display_name": { "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ", "type": "string" }, "offline_access_codes_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.can_program_online_access_codes." } }, "required": [ "display_name", "manufacturer_display_name" ], "type": "object" }, "name": { "deprecated": true, "description": "Deprecated. use device.display_name instead\n\nName of the device.", "type": "string" }, "noise_level_decibels": { "description": "Indicates current noise level in decibels, if the device supports noise detection.", "format": "float", "type": "number", "x-property-group-key": "noise_sensors" }, "offline_access_codes_enabled": { "deprecated": true, "description": "Deprecated. use device.can_program_offline_access_codes\n\nIndicates whether it is currently possible to use offline access codes for the device.", "type": "boolean", "x-property-group-key": "access_codes" }, "online": { "description": "Indicates whether the device is online.", "type": "boolean" }, "online_access_codes_enabled": { "deprecated": true, "description": "Deprecated. use device.can_program_online_access_codes\n\nIndicates whether it is currently possible to use online access codes for the device.", "type": "boolean", "x-property-group-key": "access_codes" }, "serial_number": { "description": "Serial number of the device.", "type": "string", "x-property-group-key": "hardware" }, "supports_accessory_keypad": { "deprecated": true, "type": "boolean", "x-property-group-key": "access_codes", "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "supports_offline_access_codes": { "deprecated": true, "type": "boolean", "x-property-group-key": "access_codes", "description": "Deprecated. use offline_access_codes_enabled" } }, "required": [ "online", "name", "appearance", "model" ], "type": "object" }, { "description": "\n Properties of the phone.\n ", "properties": { "assa_abloy_credential_service_metadata": { "description": "ASSA ABLOY Credential Service metadata for the phone.", "properties": { "endpoints": { "description": "Endpoints associated with the phone.", "items": { "properties": { "endpoint_id": { "description": "ID of the associated endpoint.", "type": "string" }, "is_active": { "description": "Indicated whether the endpoint is active.", "type": "boolean" } }, "type": "object" }, "type": "array" }, "has_active_endpoint": { "description": "Indicates whether the credential service has active endpoints associated with the phone.", "type": "boolean" } }, "type": "object" }, "salto_space_credential_service_metadata": { "description": "Salto Space credential service metadata for the phone.", "properties": { "has_active_phone": { "description": "Indicates whether the credential service has an active associated phone.", "type": "boolean" } }, "type": "object" } }, "type": "object" } ] }, { "description": "Provider-specific metadata.", "properties": { "akiles_metadata": { "description": "Metadata for an Akiles device.", "properties": { "_member_group_id": { "description": "Group ID to which to add users for an Akiles device.", "type": "string" }, "gadget_id": { "description": "Gadget ID for an Akiles device.", "type": "string" }, "gadget_name": { "description": "Gadget name for an Akiles device.", "type": "string" }, "product_name": { "description": "Product name for an Akiles device.", "type": "string" } }, "type": "object" }, "assa_abloy_vostio_metadata": { "description": "Metadata for an ASSA ABLOY Vostio system.", "properties": { "encoder_name": { "description": "Encoder name for an ASSA ABLOY Vostio system.", "type": "string" } }, "type": "object" }, "august_metadata": { "description": "Metadata for an August device.", "properties": { "has_keypad": { "description": "Indicates whether an August device has a keypad.", "type": "boolean" }, "house_id": { "description": "House ID for an August device.", "type": "string" }, "house_name": { "description": "House name for an August device.", "type": "string" }, "keypad_battery_level": { "description": "Keypad battery level for an August device.", "type": "string" }, "lock_id": { "description": "Lock ID for an August device.", "type": "string" }, "lock_name": { "description": "Lock name for an August device.", "type": "string" }, "model": { "description": "Model for an August device.", "type": "string" } }, "type": "object" }, "avigilon_alta_metadata": { "description": "Metadata for an Avigilon Alta system.", "properties": { "entry_name": { "description": "Entry name for an Avigilon Alta system.", "type": "string" }, "entry_relays_total_count": { "description": "Total count of entry relays for an Avigilon Alta system.", "format": "float", "type": "number" }, "org_name": { "description": "Organization name for an Avigilon Alta system.", "type": "string" }, "site_id": { "description": "Site ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "site_name": { "description": "Site name for an Avigilon Alta system.", "type": "string" }, "zone_id": { "description": "Zone ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "zone_name": { "description": "Zone name for an Avigilon Alta system.", "type": "string" } }, "type": "object" }, "brivo_metadata": { "description": "Metadata for a Brivo device.", "properties": { "activation_enabled": { "description": "Indicates whether the Brivo access point has activation (remote unlock) enabled.", "type": "boolean" }, "device_name": { "description": "Device name for a Brivo device.", "type": "string" } }, "type": "object" }, "controlbyweb_metadata": { "description": "Metadata for a ControlByWeb device.", "properties": { "device_id": { "description": "Device ID for a ControlByWeb device.", "type": "string" }, "device_name": { "description": "Device name for a ControlByWeb device.", "type": "string" }, "relay_name": { "description": "Relay name for a ControlByWeb device.", "nullable": true, "type": "string" } }, "type": "object" }, "dormakaba_oracode_metadata": { "description": "Metadata for a dormakaba Oracode device.", "properties": { "device_id": { "description": "Device ID for a dormakaba Oracode device.", "oneOf": [ { "format": "float", "type": "number" }, { "type": "string" } ] }, "door_id": { "description": "Door ID for a dormakaba Oracode device.", "format": "float", "type": "number" }, "door_is_wireless": { "description": "Indicates whether a door is wireless for a dormakaba Oracode device.", "type": "boolean" }, "door_name": { "description": "Door name for a dormakaba Oracode device.", "type": "string" }, "iana_timezone": { "description": "IANA time zone for a dormakaba Oracode device.", "type": "string" }, "predefined_time_slots": { "description": "Predefined time slots for a dormakaba Oracode device.", "items": { "description": "Time slot for a dormakaba Oracode device.", "properties": { "check_in_time": { "description": "Check in time for a time slot for a dormakaba Oracode device.", "type": "string" }, "check_out_time": { "description": "Checkout time for a time slot for a dormakaba Oracode device.", "type": "string" }, "dormakaba_oracode_user_level_id": { "description": "ID of a user level for a dormakaba Oracode device.", "format": "uuid", "type": "string" }, "dormakaba_oracode_user_level_prefix": { "description": "Prefix for a user level for a dormakaba Oracode device.", "format": "float", "type": "number" }, "is_24_hour": { "description": "Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.", "type": "boolean" }, "is_biweekly_mode": { "description": "Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.", "type": "boolean" }, "is_master": { "description": "Indicates whether a time slot for a dormakaba Oracode device is a master time slot.", "type": "boolean" }, "is_one_shot": { "description": "Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.", "type": "boolean" }, "name": { "description": "Name of a time slot for a dormakaba Oracode device.", "type": "string" }, "prefix": { "description": "Prefix for a time slot for a dormakaba Oracode device.", "format": "float", "type": "number" } }, "type": "object" }, "type": "array" }, "site_id": { "deprecated": true, "description": "Deprecated. Previously marked as \"@DEPRECATED.\"\n\nSite ID for a dormakaba Oracode device.", "format": "float", "nullable": true, "type": "number" }, "site_name": { "description": "Site name for a dormakaba Oracode device.", "type": "string" } }, "type": "object" }, "ecobee_metadata": { "description": "Metadata for an ecobee device.", "properties": { "device_name": { "description": "Device name for an ecobee device.", "type": "string" }, "ecobee_device_id": { "description": "Device ID for an ecobee device.", "type": "string" } }, "type": "object" }, "four_suites_metadata": { "description": "Metadata for a 4SUITES device.", "properties": { "device_id": { "description": "Device ID for a 4SUITES device.", "format": "float", "type": "number" }, "device_name": { "description": "Device name for a 4SUITES device.", "type": "string" }, "reclose_delay_in_seconds": { "description": "Reclose delay, in seconds, for a 4SUITES device.", "format": "float", "type": "number" } }, "type": "object" }, "genie_metadata": { "description": "Metadata for a Genie device.", "properties": { "device_name": { "description": "Lock name for a Genie device.", "type": "string" }, "door_name": { "description": "Door name for a Genie device.", "type": "string" } }, "type": "object" }, "honeywell_resideo_metadata": { "description": "Metadata for a Honeywell Resideo device.", "properties": { "device_name": { "description": "Device name for a Honeywell Resideo device.", "type": "string" }, "honeywell_resideo_device_id": { "description": "Device ID for a Honeywell Resideo device.", "type": "string" } }, "type": "object" }, "igloo_metadata": { "description": "Metadata for an igloo device.", "properties": { "bridge_id": { "description": "Bridge ID for an igloo device.", "type": "string" }, "device_id": { "description": "Device ID for an igloo device.", "type": "string" }, "model": { "description": "Model for an igloo device.", "type": "string" } }, "type": "object" }, "igloohome_metadata": { "description": "Metadata for an igloohome device.", "properties": { "bridge_id": { "description": "Bridge ID for an igloohome device.", "type": "string" }, "bridge_name": { "description": "Bridge name for an igloohome device.", "type": "string" }, "device_id": { "description": "Device ID for an igloohome device.", "type": "string" }, "device_name": { "description": "Device name for an igloohome device.", "type": "string" }, "is_accessory_keypad_linked_to_bridge": { "description": "Indicates whether a keypad is linked to a bridge for an igloohome device.", "type": "boolean" }, "keypad_id": { "description": "Keypad ID for an igloohome device.", "type": "string" } }, "type": "object" }, "keynest_metadata": { "description": "Metadata for a KeyNest device.", "properties": { "address": { "description": "Address for a KeyNest device.", "nullable": true, "type": "string" }, "current_or_last_store_id": { "description": "Current or last store ID for a KeyNest device.", "format": "float", "type": "number" }, "current_status": { "description": "Current status for a KeyNest device.", "nullable": true, "type": "string" }, "current_user_company": { "description": "Current user company for a KeyNest device.", "nullable": true, "type": "string" }, "current_user_email": { "description": "Current user email for a KeyNest device.", "nullable": true, "type": "string" }, "current_user_name": { "description": "Current user name for a KeyNest device.", "nullable": true, "type": "string" }, "current_user_phone_number": { "description": "Current user phone number for a KeyNest device.", "nullable": true, "type": "string" }, "default_office_id": { "description": "Default office ID for a KeyNest device.", "format": "float", "type": "number" }, "device_name": { "description": "Device name for a KeyNest device.", "type": "string" }, "fob_id": { "description": "Fob ID for a KeyNest device.", "format": "float", "type": "number" }, "handover_method": { "description": "Handover method for a KeyNest device.", "nullable": true, "type": "string" }, "has_photo": { "description": "Whether the KeyNest device has a photo.", "type": "boolean" }, "is_quadient_locker": { "description": "Whether the key is in a locker that does not support the access codes API.", "type": "boolean" }, "key_id": { "description": "Key ID for a KeyNest device.", "type": "string" }, "key_notes": { "description": "Key notes for a KeyNest device.", "nullable": true, "type": "string" }, "keynest_app_user": { "description": "KeyNest app user for a KeyNest device.", "nullable": true, "type": "string" }, "last_movement": { "description": "Last movement timestamp for a KeyNest device.", "type": "string" }, "property_id": { "description": "Property ID for a KeyNest device.", "nullable": true, "type": "string" }, "property_postcode": { "description": "Property postcode for a KeyNest device.", "nullable": true, "type": "string" }, "status_type": { "description": "Status type for a KeyNest device.", "type": "string" }, "subscription_plan": { "description": "Subscription plan for a KeyNest device.", "type": "string" } }, "type": "object" }, "kisi_metadata": { "description": "Metadata for a Kisi device.", "properties": { "description": { "description": "Description for a Kisi device.", "nullable": true, "type": "string" }, "lock_id": { "description": "Lock ID for a Kisi device.", "format": "float", "type": "number" }, "lock_name": { "description": "Lock name for a Kisi device.", "type": "string" }, "place_name": { "description": "Place name for a Kisi device.", "nullable": true, "type": "string" } }, "type": "object" }, "korelock_metadata": { "description": "Metadata for a Korelock device.", "properties": { "device_id": { "description": "Device ID for a Korelock device.", "type": "string" }, "device_name": { "description": "Device name for a Korelock device.", "type": "string" }, "firmware_version": { "description": "Firmware version for a Korelock device.", "type": "string" }, "location_id": { "description": "Location ID for a Korelock device. Required for timebound access codes.", "nullable": true, "type": "string" }, "model_code": { "description": "Model code for a Korelock device.", "type": "string" }, "serial_number": { "description": "Serial number for a Korelock device.", "type": "string" }, "wifi_signal_strength": { "description": "WiFi signal strength (0-1) for a Korelock device.", "format": "float", "type": "number" } }, "type": "object" }, "kwikset_metadata": { "description": "Metadata for a Kwikset device.", "properties": { "device_id": { "description": "Device ID for a Kwikset device.", "type": "string" }, "device_name": { "description": "Device name for a Kwikset device.", "type": "string" }, "model_number": { "description": "Model number for a Kwikset device.", "type": "string" } }, "type": "object" }, "lockly_metadata": { "description": "Metadata for a Lockly device.", "properties": { "device_id": { "description": "Device ID for a Lockly device.", "type": "string" }, "device_name": { "description": "Device name for a Lockly device.", "type": "string" }, "model": { "description": "Model for a Lockly device.", "type": "string" } }, "type": "object" }, "minut_metadata": { "description": "Metadata for a Minut device.", "properties": { "device_id": { "description": "Device ID for a Minut device.", "type": "string" }, "device_name": { "description": "Device name for a Minut device.", "type": "string" }, "latest_sensor_values": { "description": "Latest sensor values for a Minut device.", "properties": { "accelerometer_z": { "description": "Latest accelerometer Z-axis reading for a Minut device.", "properties": { "time": { "description": "Time of latest accelerometer Z-axis reading for a Minut device.", "type": "string" }, "value": { "description": "Value of latest accelerometer Z-axis reading for a Minut device.", "format": "float", "type": "number" } }, "type": "object" }, "humidity": { "description": "Latest humidity reading for a Minut device.", "properties": { "time": { "description": "Time of latest humidity reading for a Minut device.", "type": "string" }, "value": { "description": "Value of latest humidity reading for a Minut device.", "format": "float", "type": "number" } }, "type": "object" }, "pressure": { "description": "Latest pressure reading for a Minut device.", "properties": { "time": { "description": "Time of latest pressure reading for a Minut device.", "type": "string" }, "value": { "description": "Value of latest pressure reading for a Minut device.", "format": "float", "type": "number" } }, "type": "object" }, "sound": { "description": "Latest sound reading for a Minut device.", "properties": { "time": { "description": "Time of latest sound reading for a Minut device.", "type": "string" }, "value": { "description": "Value of latest sound reading for a Minut device.", "format": "float", "type": "number" } }, "type": "object" }, "temperature": { "description": "Latest temperature reading for a Minut device.", "properties": { "time": { "description": "Time of latest temperature reading for a Minut device.", "type": "string" }, "value": { "description": "Value of latest temperature reading for a Minut device.", "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "nest_metadata": { "description": "Metadata for a Google Nest device.", "properties": { "device_custom_name": { "description": "Custom device name for a Google Nest device. The device owner sets this value.", "type": "string" }, "device_name": { "description": "Device name for a Google Nest device. Google sets this value.", "type": "string" }, "display_name": { "description": "Display name for a Google Nest device.", "type": "string" }, "nest_device_id": { "description": "Device ID for a Google Nest device.", "type": "string" } }, "type": "object" }, "noiseaware_metadata": { "description": "Metadata for a NoiseAware device.", "properties": { "device_id": { "description": "Device ID for a NoiseAware device.", "type": "string" }, "device_model": { "description": "Device model for a NoiseAware device.", "enum": [ "indoor", "outdoor" ], "type": "string" }, "device_name": { "description": "Device name for a NoiseAware device.", "type": "string" }, "noise_level_decibel": { "description": "Noise level, in decibels, for a NoiseAware device.", "format": "float", "type": "number" }, "noise_level_nrs": { "description": "Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.", "format": "float", "type": "number" } }, "type": "object" }, "nuki_metadata": { "description": "Metadata for a Nuki device.", "properties": { "device_id": { "description": "Device ID for a Nuki device.", "type": "string" }, "device_name": { "description": "Device name for a Nuki device.", "type": "string" }, "keypad_2_paired": { "description": "Indicates whether keypad 2 is paired for a Nuki device.", "type": "boolean" }, "keypad_battery_critical": { "description": "Indicates whether the keypad battery is in a critical state for a Nuki device.", "type": "boolean" }, "keypad_paired": { "description": "Indicates whether the keypad is paired for a Nuki device.", "type": "boolean" } }, "type": "object" }, "omnitec_metadata": { "description": "Metadata for an Omnitec device.", "properties": { "has_gateway": { "description": "Whether the Omnitec lock has a connected gateway for remote operations.", "type": "boolean" }, "lock_alias": { "description": "Operator-assigned alias for an Omnitec device.", "type": "string" }, "lock_id": { "description": "Lock ID for an Omnitec device.", "format": "float", "type": "number" }, "lock_mac": { "description": "Bluetooth MAC address for an Omnitec device.", "type": "string" }, "lock_name": { "description": "Lock name for an Omnitec device.", "type": "string" }, "time_zone": { "description": "IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).", "nullable": true, "type": "string" }, "timezone_raw_offset_ms": { "description": "Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.", "format": "float", "type": "number" } }, "type": "object" }, "ring_metadata": { "description": "Metadata for a Ring device.", "properties": { "device_id": { "description": "Device ID for a Ring device.", "type": "string" }, "device_name": { "description": "Device name for a Ring device.", "type": "string" } }, "type": "object" }, "salto_ks_metadata": { "description": "Metadata for a Salto KS device.", "properties": { "battery_level": { "description": "Battery level for a Salto KS device.", "type": "string" }, "customer_reference": { "description": "Customer reference for a Salto KS device.", "type": "string" }, "has_custom_pin_subscription": { "description": "Indicates whether the site has a Salto KS subscription that supports custom PINs.", "type": "boolean" }, "lock_id": { "description": "Lock ID for a Salto KS device.", "type": "string" }, "lock_type": { "description": "Lock type for a Salto KS device.", "type": "string" }, "locked_state": { "description": "Locked state for a Salto KS device.", "type": "string" }, "model": { "description": "Model for a Salto KS device.", "type": "string" }, "site_id": { "description": "Site ID for the Salto KS site to which the device belongs.", "type": "string" }, "site_name": { "description": "Site name for the Salto KS site to which the device belongs.", "type": "string" } }, "type": "object" }, "salto_metadata": { "deprecated": true, "description": "Deprecated. Use `salto_ks_metadata ` instead.\n\nMetada for a Salto device.", "properties": { "battery_level": { "description": "Battery level for a Salto device.", "type": "string" }, "customer_reference": { "description": "Customer reference for a Salto device.", "type": "string" }, "lock_id": { "description": "Lock ID for a Salto device.", "type": "string" }, "lock_type": { "description": "Lock type for a Salto device.", "type": "string" }, "locked_state": { "description": "Locked state for a Salto device.", "type": "string" }, "model": { "description": "Model for a Salto device.", "type": "string" }, "site_id": { "description": "Site ID for the Salto KS site to which the device belongs.", "type": "string" }, "site_name": { "description": "Site name for the Salto KS site to which the device belongs.", "type": "string" } }, "type": "object" }, "schlage_metadata": { "description": "Metadata for a Schlage device.", "properties": { "device_id": { "description": "Device ID for a Schlage device.", "type": "string" }, "device_name": { "description": "Device name for a Schlage device.", "type": "string" }, "model": { "description": "Model for a Schlage device.", "type": "string" } }, "type": "object" }, "seam_bridge_metadata": { "description": "Metadata for Seam Bridge.", "properties": { "device_num": { "description": "Device number for Seam Bridge.", "format": "float", "type": "number" }, "name": { "description": "Name for Seam Bridge.", "type": "string" }, "unlock_method": { "description": "Unlock method for Seam Bridge.", "enum": [ "bridge", "doorking" ], "type": "string" } }, "type": "object" }, "sensi_metadata": { "description": "Metadata for a Sensi device.", "properties": { "device_id": { "description": "Device ID for a Sensi device.", "type": "string" }, "device_name": { "description": "Device name for a Sensi device.", "type": "string" }, "dual_setpoints_not_supported": { "description": "Set to true when the device does not support the /dual-setpoints API endpoint.", "type": "boolean" }, "enforced_setpoint_range_celsius": { "description": "Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error." }, "product_type": { "description": "Product type for a Sensi device.", "type": "string" } }, "type": "object" }, "smartthings_metadata": { "description": "Metadata for a SmartThings device.", "properties": { "device_id": { "description": "Device ID for a SmartThings device.", "type": "string" }, "device_name": { "description": "Device name for a SmartThings device.", "type": "string" }, "location_id": { "description": "Location ID for a SmartThings device.", "type": "string" }, "model": { "description": "Model for a SmartThings device.", "type": "string" } }, "type": "object" }, "tado_metadata": { "description": "Metadata for a tado° device.", "properties": { "device_type": { "description": "Device type for a tado° device.", "type": "string" }, "serial_no": { "description": "Serial number for a tado° device.", "type": "string" } }, "type": "object" }, "tedee_metadata": { "description": "Metadata for a Tedee device.", "properties": { "bridge_id": { "description": "Bridge ID for a Tedee device.", "format": "float", "type": "number" }, "bridge_name": { "description": "Bridge name for a Tedee device.", "type": "string" }, "device_id": { "description": "Device ID for a Tedee device.", "format": "float", "type": "number" }, "device_model": { "description": "Device model for a Tedee device.", "type": "string" }, "device_name": { "description": "Device name for a Tedee device.", "type": "string" }, "keypad_id": { "description": "Keypad ID for a Tedee device.", "format": "float", "type": "number" }, "serial_number": { "description": "Serial number for a Tedee device.", "type": "string" } }, "type": "object" }, "ttlock_metadata": { "description": "Metadata for a TTLock device.", "properties": { "feature_value": { "description": "Feature value for a TTLock device.", "type": "string" }, "features": { "description": "Features for a TTLock device.", "properties": { "auto_lock_time_config": { "description": "Indicates whether a TTLock device supports auto-lock time configuration.", "type": "boolean" }, "incomplete_keyboard_passcode": { "description": "Indicates whether a TTLock device supports an incomplete keyboard passcode.", "type": "boolean" }, "lock_command": { "description": "Indicates whether a TTLock device supports the lock command.", "type": "boolean" }, "passcode": { "description": "Indicates whether a TTLock device supports a passcode.", "type": "boolean" }, "passcode_management": { "description": "Indicates whether a TTLock device supports passcode management.", "type": "boolean" }, "unlock_via_gateway": { "description": "Indicates whether a TTLock device supports unlock via gateway.", "type": "boolean" }, "wifi": { "description": "Indicates whether a TTLock device supports Wi-Fi.", "type": "boolean" } }, "type": "object" }, "has_gateway": { "description": "Indicates whether a TTLock device has a gateway.", "type": "boolean" }, "lock_alias": { "description": "Lock alias for a TTLock device.", "type": "string" }, "lock_id": { "description": "Lock ID for a TTLock device.", "format": "float", "type": "number" }, "timezone_raw_offset_ms": { "description": "Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock's wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer \"codes offset by N hours\" reports. Diagnostic only; Seam does not convert times based on this value.", "format": "float", "nullable": true, "type": "number" }, "wireless_keypads": { "description": "Wireless keypads for a TTLock device.", "items": { "properties": { "wireless_keypad_id": { "description": "ID for a wireless keypad for a TTLock device.", "format": "float", "type": "number" }, "wireless_keypad_name": { "description": "Name for a wireless keypad for a TTLock device.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "two_n_metadata": { "description": "Metadata for a 2N device.", "properties": { "device_id": { "description": "Device ID for a 2N device.", "format": "float", "type": "number" }, "device_name": { "description": "Device name for a 2N device.", "type": "string" } }, "type": "object" }, "ultraloq_metadata": { "description": "Metadata for an Ultraloq device.", "properties": { "device_id": { "description": "Device ID for an Ultraloq device.", "type": "string" }, "device_name": { "description": "Device name for an Ultraloq device.", "type": "string" }, "device_type": { "description": "Device type for an Ultraloq device.", "type": "string" }, "time_zone": { "description": "IANA timezone for the Ultraloq device.", "nullable": true, "type": "string" } }, "type": "object" }, "visionline_metadata": { "description": "Metadata for an ASSA ABLOY Visionline system.", "properties": { "encoder_id": { "description": "Encoder ID for an ASSA ABLOY Visionline system.", "type": "string" } }, "type": "object" }, "wyze_metadata": { "description": "Metadata for a Wyze device.", "properties": { "device_id": { "description": "Device ID for a Wyze device.", "type": "string" }, "device_info_model": { "description": "Device information model for a Wyze device.", "type": "string" }, "device_name": { "description": "Device name for a Wyze device.", "type": "string" }, "keypad_uuid": { "description": "Keypad UUID for a Wyze device.", "type": "string" }, "locker_status_hardlock": { "description": "Locker status (hardlock) for a Wyze device.", "format": "float", "type": "number" }, "product_model": { "description": "Product model for a Wyze device.", "type": "string" }, "product_name": { "description": "Product name for a Wyze device.", "type": "string" }, "product_type": { "description": "Product type for a Wyze device.", "type": "string" } }, "type": "object" } }, "type": "object", "x-property-group-key": "provider_metadata" } ] }, { "allOf": [ { "properties": { "auto_lock_delay_seconds": { "description": "The delay in seconds before the lock automatically locks after being unlocked.", "format": "float", "type": "number", "x-property-group-key": "locks" }, "auto_lock_enabled": { "description": "Indicates whether automatic locking is enabled.", "type": "boolean", "x-property-group-key": "locks" }, "backup_access_code_pool_enabled": { "description": "Indicates whether the [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](/api/devices/update).", "type": "boolean", "x-property-group-key": "access_codes" }, "code_constraints": { "description": "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.", "items": { "description": "Access code constraint.", "oneOf": [ { "description": "Code constraint for access codes.", "properties": { "constraint_type": { "description": "Code constraint type for access codes.", "enum": [ "no_zeros", "cannot_start_with_12", "no_triple_consecutive_ints", "cannot_specify_pin_code", "pin_code_matches_existing_set", "start_date_in_future", "no_ascending_or_descending_sequence", "at_least_three_unique_digits", "cannot_contain_089", "cannot_contain_0789", "unique_first_four_digits", "no_all_same_digits" ], "type": "string" } }, "required": [ "constraint_type" ], "type": "object" }, { "description": "Name constraint for access codes.", "properties": { "constraint_type": { "enum": [ "name_length", "name_must_be_unique" ], "type": "string" }, "max_length": { "description": "Maximum name length constraint for access codes.", "format": "float", "type": "number" }, "min_length": { "description": "Minimum name length constraint for access codes.", "format": "float", "type": "number" } }, "required": [ "constraint_type" ], "type": "object" } ] }, "type": "array", "x-property-group-key": "access_codes" }, "door_open": { "description": "Indicates whether the door is open.", "type": "boolean", "x-property-group-key": "locks" }, "has_native_entry_events": { "description": "Indicates whether the device supports native entry events.", "type": "boolean", "x-property-group-key": "access_codes" }, "keypad_battery": { "description": "Keypad battery status.", "properties": { "level": { "description": "\n Keypad battery charge level.\n ", "format": "float", "type": "number" } }, "required": [ "level" ], "type": "object", "x-property-group-key": "access_codes" }, "locked": { "description": "Indicates whether the lock is locked.", "type": "boolean", "x-property-group-key": "locks" }, "max_active_codes_supported": { "description": "Maximum number of active access codes that the device supports.", "format": "float", "type": "number", "x-property-group-key": "access_codes" }, "offline_time_frame_options": { "description": "Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.", "items": { "description": "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.", "properties": { "display_name": { "description": "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).", "type": "string" }, "end_date_recurrence_rule": { "description": "iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.", "type": "string" }, "matching_start_end_time": { "description": "When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.", "enum": [ true ], "type": "boolean" }, "max_duration": { "description": "Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.", "type": "string" }, "min_duration": { "description": "Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.", "type": "string" }, "start_date_recurrence_rule": { "description": "iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.", "type": "string" }, "time_pairs": { "description": "Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.", "items": { "description": "Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.", "properties": { "display_name": { "description": "Label for the start/end time pairing.", "type": "string" }, "end_time": { "description": "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.", "type": "string" }, "start_time": { "description": "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.", "type": "string" } }, "required": [ "display_name", "start_time", "end_time" ], "type": "object" }, "type": "array" }, "time_zone": { "description": "IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.", "type": "string" } }, "required": [ "display_name" ], "type": "object" }, "type": "array", "x-property-group-key": "access_codes" }, "online_time_frame_options": { "description": "Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.", "items": { "description": "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.", "properties": { "display_name": { "description": "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).", "type": "string" }, "end_date_recurrence_rule": { "description": "iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.", "type": "string" }, "matching_start_end_time": { "description": "When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.", "enum": [ true ], "type": "boolean" }, "max_duration": { "description": "Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.", "type": "string" }, "min_duration": { "description": "Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.", "type": "string" }, "start_date_recurrence_rule": { "description": "iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.", "type": "string" }, "time_pairs": { "description": "Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.", "items": { "description": "Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.", "properties": { "display_name": { "description": "Label for the start/end time pairing.", "type": "string" }, "end_time": { "description": "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.", "type": "string" }, "start_time": { "description": "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.", "type": "string" } }, "required": [ "display_name", "start_time", "end_time" ], "type": "object" }, "type": "array" }, "time_zone": { "description": "IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.", "type": "string" } }, "required": [ "display_name" ], "type": "object" }, "type": "array", "x-property-group-key": "access_codes" }, "supported_code_lengths": { "description": "Supported code lengths for access codes.", "items": { "format": "float", "type": "number" }, "type": "array", "x-property-group-key": "access_codes" }, "supports_backup_access_code_pool": { "description": "Indicates whether the device supports a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes).", "type": "boolean", "x-property-group-key": "access_codes" } }, "type": "object" }, { "properties": { "active_thermostat_schedule": { "deprecated": true, "description": "Deprecated. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.\n\nActive [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "nullable": true, "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "type": "string" }, "created_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the desired [thermostat](/capability-guides/thermostats) device.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "errors": { "description": "Errors associated with the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "items": { "properties": { "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "is_override_allowed": { "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.", "type": "boolean" }, "max_override_period_minutes": { "description": "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "exclusiveMinimum": true, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "description": "User-friendly name to identify the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "thermostat_schedule_id": { "description": "ID of the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the thermostat schedule.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id", "device_id", "name", "climate_preset_key", "starts_at", "ends_at", "workspace_id", "created_at", "errors" ], "type": "object", "x-property-group-key": "thermostats", "x-route-path": "/thermostats/schedules" }, "active_thermostat_schedule_id": { "description": "ID of the active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "format": "uuid", "nullable": true, "type": "string", "x-property-group-key": "thermostats" }, "available_climate_preset_modes": { "description": "Climate preset modes that the thermostat supports, such as \"home\", \"away\", \"wake\", \"sleep\", \"occupied\", and \"unoccupied\".", "items": { "description": "Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "type": "array", "x-property-group-key": "thermostats" }, "available_climate_presets": { "description": "Available [climate presets](/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.", "items": { "properties": { "can_delete": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.", "type": "boolean" }, "can_edit": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.", "type": "boolean" }, "can_use_with_thermostat_daily_programs": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.", "type": "boolean" }, "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "display_name": { "description": "Display name for the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "required": [ "climate_preset_key", "can_edit", "can_delete", "can_use_with_thermostat_daily_programs", "display_name", "manual_override_allowed" ], "type": "object" }, "type": "array", "x-property-group-key": "thermostats" }, "available_fan_mode_settings": { "description": "Fan mode settings that the thermostat supports.", "items": { "description": "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "type": "array", "x-property-group-key": "thermostats" }, "available_hvac_mode_settings": { "description": "HVAC mode settings that the thermostat supports.", "items": { "description": "HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "type": "array", "x-property-group-key": "thermostats" }, "current_climate_setting": { "description": "Current climate setting.", "properties": { "can_delete": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.", "type": "boolean" }, "can_edit": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.", "type": "boolean" }, "can_use_with_thermostat_daily_programs": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.", "type": "boolean" }, "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "display_name": { "description": "Display name for the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "type": "object", "x-property-group-key": "thermostats" }, "default_climate_setting": { "deprecated": true, "properties": { "can_delete": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.", "type": "boolean" }, "can_edit": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.", "type": "boolean" }, "can_use_with_thermostat_daily_programs": { "description": "Indicates whether the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.", "type": "boolean" }, "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "display_name": { "description": "Display name for the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "type": "object", "x-property-group-key": "thermostats", "description": "Deprecated. use fallback_climate_preset_key to specify a fallback climate preset instead." }, "fallback_climate_preset_key": { "description": "Key of the [fallback climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.", "minLength": 1, "nullable": true, "type": "string", "x-property-group-key": "thermostats" }, "fan_mode_setting": { "deprecated": true, "enum": [ "auto", "on", "circulate" ], "type": "string", "x-property-group-key": "thermostats", "description": "Deprecated. Use `current_climate_setting.fan_mode_setting` instead." }, "is_cooling": { "description": "Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.", "type": "boolean", "x-property-group-key": "thermostats" }, "is_fan_running": { "description": "Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.", "type": "boolean", "x-property-group-key": "thermostats" }, "is_heating": { "description": "Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.", "type": "boolean", "x-property-group-key": "thermostats" }, "is_temporary_manual_override_active": { "description": "Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.", "type": "boolean", "x-property-group-key": "thermostats" }, "max_cooling_set_point_celsius": { "description": "Maximum [cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "max_cooling_set_point_fahrenheit": { "description": "Maximum [cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "max_heating_set_point_celsius": { "description": "Maximum [heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "max_heating_set_point_fahrenheit": { "description": "Maximum [heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "max_thermostat_daily_program_periods_per_day": { "description": "Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "max_unique_climate_presets_per_thermostat_weekly_program": { "description": "Maximum number of climate presets that the thermostat can support for weekly programming.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_cooling_set_point_celsius": { "description": "Minimum [cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_cooling_set_point_fahrenheit": { "description": "Minimum [cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_heating_cooling_delta_celsius": { "description": "Minimum [temperature difference](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_heating_cooling_delta_fahrenheit": { "description": "Minimum [temperature difference](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_heating_set_point_celsius": { "description": "Minimum [heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "min_heating_set_point_fahrenheit": { "description": "Minimum [heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "relative_humidity": { "description": "Reported relative humidity, as a value between 0 and 1, inclusive.", "format": "float", "maximum": 1, "minimum": 0, "type": "number", "x-property-group-key": "thermostats" }, "temperature_celsius": { "description": "Reported temperature in °C.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "temperature_fahrenheit": { "description": "Reported temperature in °F.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "temperature_threshold": { "description": "Current [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.", "properties": { "lower_limit_celsius": { "description": "Lower limit in °C within the current [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ", "format": "float", "nullable": true, "type": "number" }, "lower_limit_fahrenheit": { "description": "Lower limit in °F within the current [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ", "format": "float", "nullable": true, "type": "number" }, "upper_limit_celsius": { "description": "Upper limit in °C within the current [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ", "format": "float", "nullable": true, "type": "number" }, "upper_limit_fahrenheit": { "description": "Upper limit in °F within the current [temperature threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ", "format": "float", "nullable": true, "type": "number" } }, "required": [ "lower_limit_celsius", "lower_limit_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit" ], "type": "object", "x-property-group-key": "thermostats" }, "thermostat_daily_program_period_precision_minutes": { "description": "Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.", "format": "float", "type": "number", "x-property-group-key": "thermostats" }, "thermostat_daily_programs": { "description": "Configured [daily programs](/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.", "items": { "description": "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.", "properties": { "created_at": { "description": "Date and time at which the thermostat daily program was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the thermostat device on which the thermostat daily program is configured.", "format": "uuid", "type": "string" }, "name": { "description": "User-friendly name to identify the thermostat daily program.", "nullable": true, "type": "string" }, "periods": { "description": "Array of thermostat daily program periods.", "items": { "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.", "type": "string" }, "starts_at_time": { "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "type": "string" } }, "required": [ "starts_at_time", "climate_preset_key" ], "type": "object" }, "type": "array" }, "thermostat_daily_program_id": { "description": "ID of the thermostat daily program.", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the thermostat daily program.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_daily_program_id", "device_id", "name", "periods", "workspace_id", "created_at" ], "type": "object", "x-route-path": "/thermostats/daily_programs" }, "type": "array", "x-property-group-key": "thermostats" }, "thermostat_weekly_program": { "description": "Current [weekly program](/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.", "nullable": true, "properties": { "created_at": { "description": "Date and time at which the thermostat weekly program was created.", "format": "date-time", "type": "string" }, "friday_program_id": { "description": "ID of the thermostat daily program to run on Fridays.", "format": "uuid", "nullable": true, "type": "string" }, "monday_program_id": { "description": "ID of the thermostat daily program to run on Mondays.", "format": "uuid", "nullable": true, "type": "string" }, "saturday_program_id": { "description": "ID of the thermostat daily program to run on Saturdays.", "format": "uuid", "nullable": true, "type": "string" }, "sunday_program_id": { "description": "ID of the thermostat daily program to run on Sundays.", "format": "uuid", "nullable": true, "type": "string" }, "thursday_program_id": { "description": "ID of the thermostat daily program to run on Thursdays.", "format": "uuid", "nullable": true, "type": "string" }, "tuesday_program_id": { "description": "ID of the thermostat daily program to run on Tuesdays.", "format": "uuid", "nullable": true, "type": "string" }, "wednesday_program_id": { "description": "ID of the thermostat daily program to run on Wednesdays.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "monday_program_id", "tuesday_program_id", "wednesday_program_id", "thursday_program_id", "friday_program_id", "saturday_program_id", "sunday_program_id", "created_at" ], "type": "object", "x-property-group-key": "thermostats" } }, "type": "object" } ] } ], "description": "Properties of the device.", "x-property-groups": { "access_codes": { "name": "Access Codes" }, "hardware": { "name": "Hardware" }, "locks": { "name": "Locks" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" }, "thermostats": { "name": "Thermostats" } } }, "space_ids": { "description": "IDs of the spaces the device is in.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "warnings": { "type": "array", "description": "Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "Unique identifier for the Seam workspace associated with the device.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "device_type", "space_ids", "display_name", "capabilities_supported", "properties", "connected_account_id", "workspace_id", "errors", "warnings", "created_at", "is_managed", "custom_metadata" ], "type": "object", "x-property-groups": { "access_codes": { "name": "Access Codes" }, "hardware": { "name": "Hardware" }, "locks": { "name": "Locks" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" }, "thermostats": { "name": "Thermostats" } }, "x-route-path": "/devices" }, "device_provider": { "properties": { "can_configure_auto_lock": { "description": "Indicates whether the lock supports configuring automatic locking.", "type": "boolean" }, "can_hvac_cool": { "description": "Indicates whether the thermostat supports cooling.", "type": "boolean" }, "can_hvac_heat": { "description": "Indicates whether the thermostat supports heating.", "type": "boolean" }, "can_hvac_heat_cool": { "description": "Indicates whether the thermostat supports simultaneous heating and cooling.", "type": "boolean" }, "can_program_offline_access_codes": { "description": "Indicates whether the device supports programming offline access codes.", "type": "boolean" }, "can_program_online_access_codes": { "description": "Indicates whether the device supports programming online access codes.", "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "description": "Indicates whether the thermostat supports different climate programs for each day of the week.", "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "description": "Indicates whether the thermostat supports a single climate program applied to every day.", "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "description": "Indicates whether the thermostat supports weekday/weekend climate programs.", "type": "boolean" }, "can_remotely_lock": { "description": "Indicates whether the device supports remote locking.", "type": "boolean" }, "can_remotely_unlock": { "description": "Indicates whether the device supports remote unlocking.", "type": "boolean" }, "can_run_thermostat_programs": { "description": "Indicates whether the thermostat supports running climate programs.", "type": "boolean" }, "can_simulate_connection": { "description": "Indicates whether the device supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_disconnection": { "description": "Indicates whether the device supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_hub_connection": { "description": "Indicates whether the hub supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_hub_disconnection": { "description": "Indicates whether the hub supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_paid_subscription": { "description": "Indicates whether the device supports simulating a paid subscription in a sandbox.", "type": "boolean" }, "can_simulate_removal": { "description": "Indicates whether the device supports simulating removal in a sandbox.", "type": "boolean" }, "can_turn_off_hvac": { "description": "Indicates whether the thermostat can be turned off.", "type": "boolean" }, "can_unlock_with_code": { "description": "Indicates whether the lock supports unlocking with an access code.", "type": "boolean" }, "device_provider_name": { "description": "Name of the device provider.", "enum": [ "hotek", "dormakaba_community", "legic_connect", "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "schlage", "smartthings", "yale", "genie", "doorking", "salto", "salto_ks", "lockly", "ttlock", "linear", "noiseaware", "nuki", "igloo", "kwikset", "minut", "my_2n", "controlbyweb", "nest", "igloohome", "ecobee", "four_suites", "dormakaba_oracode", "pti", "wyze", "seam_passport", "visionline", "assa_abloy_credential_service", "tedee", "honeywell_resideo", "first_alert", "latch", "akiles", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "tado", "salto_space", "sensi", "keynest", "korelock", "keyincode", "dormakaba_ambiance", "ultraloq", "dusaw", "sifely", "thirty_three_lock", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi" ], "type": "string" }, "display_name": { "description": "Display name for the device provider.", "type": "string" }, "image_url": { "description": "Image URL for the device provider.", "type": "string" }, "provider_categories": { "description": "List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.", "items": { "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras", "connectors" ], "type": "string" }, "type": "array" } }, "required": [ "device_provider_name", "display_name", "image_url", "provider_categories" ], "type": "object", "x-route-path": "/devices", "description": "See the [device_provider object](/api/devices/object)." }, "enrollment_automation": { "description": "Represents an [enrollment automation](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](/capability-guides/mobile-access).", "properties": { "created_at": { "description": "Date and time at which the enrollment automation was created.", "format": "date-time", "type": "string" }, "credential_manager_acs_system_id": { "description": "ID of the associated [ACS system](/low-level-apis/access-systems) that serves as the credential manager.", "format": "uuid", "type": "string" }, "enrollment_automation_id": { "description": "ID of the enrollment automation.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the associated [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the enrollment automation.", "format": "uuid", "type": "string" } }, "required": [ "enrollment_automation_id", "credential_manager_acs_system_id", "user_identity_id", "created_at", "workspace_id" ], "type": "object", "x-route-path": "/user_identities/enrollment_automations" }, "event": { "description": "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event. See the [event object](/api/events/object).", "discriminator": { "propertyName": "event_type" }, "oneOf": [ { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was created.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was changed.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "change_reason": { "description": "Human-readable reason for the change (e.g. `ongoing code auto-renewed`).", "type": "string" }, "changed_properties": { "description": "List of properties that changed on the access code.", "items": { "description": "Record describing a single changed property.", "properties": { "from": { "description": "Previous value of the property, or null if not set.", "nullable": true, "type": "string" }, "property": { "description": "Name of the property that changed (e.g. `code`).", "type": "string" }, "to": { "description": "New value of the property, or null if cleared.", "nullable": true, "type": "string" } }, "required": [ "property", "from", "to" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "The name of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable description of the change and its source.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.name_changed" ], "type": "string" }, "from": { "description": "Previous access code name configuration.", "properties": { "name": { "description": "Previous name of the access code.", "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "to": { "description": "New access code name configuration.", "properties": { "name": { "description": "New name of the access code.", "nullable": true, "type": "string" } }, "required": [ "name" ], "type": "object" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "from", "to", "description" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "The pin code of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable description of the change and its source.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.code_changed" ], "type": "string" }, "from": { "description": "Previous pin code configuration.", "properties": { "code": { "description": "Previous pin code.", "nullable": true, "type": "string" } }, "required": [ "code" ], "type": "object" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "to": { "description": "New pin code configuration.", "properties": { "code": { "description": "New pin code.", "nullable": true, "type": "string" } }, "required": [ "code" ], "type": "object" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "from", "to", "description" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "The time frame of an [access code](/low-level-apis/smart-locks/access-codes) was changed on the device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "description": { "description": "Human-readable description of the change and its source.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.time_frame_changed" ], "type": "string" }, "from": { "description": "Previous time frame configuration.", "properties": { "ends_at": { "description": "Previous end time.", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time.", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "to": { "description": "New time frame configuration.", "properties": { "ends_at": { "description": "New end time.", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time.", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "from", "to", "description" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "Mutations were requested on an [access code](/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.mutations_requested" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "requested_mutations": { "description": "Array of mutations requested on the access code, each containing the mutation type and from/to values.", "items": { "description": "Record describing a single requested mutation.", "properties": { "from": { "additionalProperties": {}, "description": "Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.", "type": "object" }, "mutation_code": { "description": "Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.", "enum": [ "updating_name", "updating_code", "updating_time_frame", "deleting", "creating", "deferring_creation" ], "type": "string" }, "to": { "additionalProperties": {}, "description": "New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.", "type": "object" } }, "required": [ "mutation_code" ], "type": "object" }, "type": "array" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "requested_mutations" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was [scheduled natively](/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "code": { "description": "Code for the affected access code.", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.scheduled_on_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was set on a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "code": { "description": "Code for the affected access code.", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.set_on_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was removed from a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.removed_from_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "There was an unusually long delay in setting an [access code](/low-level-apis/smart-locks/access-codes) on a device.", "properties": { "access_code_errors": { "description": "Errors associated with the access code.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "access_code_warnings": { "description": "Warnings associated with the access code.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.delay_in_setting_on_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be set on a device.", "properties": { "access_code_errors": { "description": "Errors associated with the access code.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "access_code_warnings": { "description": "Warnings associated with the access code.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.failed_to_set_on_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "code": { "description": "Code for the affected access code.", "nullable": true, "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "code" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "There was an unusually long delay in removing an [access code](/low-level-apis/smart-locks/access-codes) from a device.", "properties": { "access_code_errors": { "description": "Errors associated with the access code.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "access_code_warnings": { "description": "Warnings associated with the access code.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.delay_in_removing_from_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) failed to be removed from a device.", "properties": { "access_code_errors": { "description": "Errors associated with the access code.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "access_code_warnings": { "description": "Warnings associated with the access code.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.failed_to_remove_from_device" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was modified outside of Seam.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.modified_external_to_seam" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [access code](/low-level-apis/smart-locks/access-codes) was deleted outside of Seam.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.deleted_external_to_seam" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "A [backup access code](/low-level-apis/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "backup_access_code_id": { "description": "ID of the backup access code that was pulled from the pool.", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.backup_access_code_pulled" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "backup_access_code_id" ], "type": "object", "x-route-path": "/access_codes" }, { "description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.unmanaged.converted_to_managed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes/unmanaged" }, { "description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.", "properties": { "access_code_errors": { "description": "Errors associated with the access code.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "access_code_warnings": { "description": "Warnings associated with the access code.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.unmanaged.failed_to_convert_to_managed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings", "access_code_errors", "access_code_warnings" ], "type": "object", "x-route-path": "/access_codes/unmanaged" }, { "description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.unmanaged.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes/unmanaged" }, { "description": "An [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.", "properties": { "access_code_id": { "description": "ID of the affected access code.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the affected access code.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the device associated with the affected access code.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_code.unmanaged.removed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_code_id", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/access_codes/unmanaged" }, { "description": "An Access Grant was created.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "An Access Grant was deleted.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "All access requested for an Access Grant was successfully granted.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.access_granted_to_all_doors" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "Access requested as part of an Access Grant to a particular door was successfully granted.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the affected [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.access_granted_to_door" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "acs_entrance_id" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "Access to a particular door that was requested as part of an Access Grant was lost.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the affected [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.access_to_door_lost" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "acs_entrance_id" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "An Access Grant's start or end time was changed.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Key of the affected Access Grant (if present).", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "ends_at": { "description": "The new end time for the access grant.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.access_times_changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "starts_at": { "description": "The new start time for the access grant.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "One or more requested access methods could not be created for an Access Grant.", "properties": { "access_grant_id": { "description": "ID of the affected Access Grant.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "error_message": { "description": "Description of why the access methods could not be created.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_grant.could_not_create_requested_access_methods" ], "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_grant_id", "event_type", "error_message" ], "type": "object", "x-route-path": "/access_grants" }, { "description": "An access method was issued.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods (only present when mode is 'code').", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.issued" ], "type": "string" }, "is_backup_code": { "description": "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).", "type": "boolean" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An access method was revoked.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.revoked" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An access method representing a physical card requires encoding.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.card_encoding_required" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An access method was deleted.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An access method was reissued.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods (only present when mode is 'code').", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.reissued" ], "type": "string" }, "is_backup_code": { "description": "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).", "type": "boolean" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An access method was created.", "properties": { "access_grant_ids": { "description": "IDs of the access grants associated with this access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants associated with this access method (if present).", "items": { "type": "string" }, "type": "array" }, "access_method_id": { "description": "ID of the affected access method.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "access_method.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "access_method_id", "access_grant_ids", "event_type" ], "type": "object", "x-route-path": "/access_methods" }, { "description": "An [access system](/low-level-apis/access-systems) was connected.", "properties": { "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_system.connected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type" ], "type": "object", "x-route-path": "/acs/systems" }, { "description": "An [access system](/low-level-apis/access-systems) was added.", "properties": { "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_system.added" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type" ], "type": "object", "x-route-path": "/acs/systems" }, { "description": "An [access system](/low-level-apis/access-systems) was disconnected.", "properties": { "acs_system_errors": { "description": "Errors associated with the access control system.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "acs_system_warnings": { "description": "Warnings associated with the access control system.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_system.disconnected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "event_type", "acs_system_errors", "acs_system_warnings", "connected_account_errors", "connected_account_warnings" ], "type": "object", "x-route-path": "/acs/systems" }, { "description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was deleted.", "properties": { "acs_credential_id": { "description": "ID of the affected credential.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_credential.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "type": "object", "x-route-path": "/acs/credentials" }, { "description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was issued.", "properties": { "acs_credential_id": { "description": "ID of the affected credential.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_credential.issued" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "type": "object", "x-route-path": "/acs/credentials" }, { "description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was reissued.", "properties": { "acs_credential_id": { "description": "ID of the affected credential.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_credential.reissued" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "type": "object", "x-route-path": "/acs/credentials" }, { "description": "An [access system credential](/low-level-apis/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore.", "properties": { "acs_credential_id": { "description": "ID of the affected credential.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_credential.invalidated" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_credential_id", "event_type" ], "type": "object", "x-route-path": "/acs/credentials" }, { "description": "An [access system user](/low-level-apis/access-systems/user-management) was created.", "properties": { "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the affected access system user.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_user.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_user_id", "event_type" ], "type": "object", "x-route-path": "/acs/users" }, { "description": "An [access system user](/low-level-apis/access-systems/user-management) was deleted.", "properties": { "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the affected access system user.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_user.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_user_id", "event_type" ], "type": "object", "x-route-path": "/acs/users" }, { "description": "An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was added.", "properties": { "acs_encoder_id": { "description": "ID of the affected encoder.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_encoder.added" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_encoder_id", "event_type" ], "type": "object", "x-route-path": "/acs/encoders" }, { "description": "An [access system encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was removed.", "properties": { "acs_encoder_id": { "description": "ID of the affected encoder.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_encoder.removed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_encoder_id", "event_type" ], "type": "object", "x-route-path": "/acs/encoders" }, { "description": "An ACS access group was deleted.", "properties": { "acs_access_group_id": { "description": "ID of the affected access group.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_access_group.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_access_group_id", "event_type" ], "type": "object", "x-route-path": "/acs/access_groups" }, { "description": "An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was added.", "properties": { "acs_entrance_id": { "description": "ID of the affected entrance.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_entrance.added" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_entrance_id", "event_type" ], "type": "object", "x-route-path": "/acs/entrances" }, { "description": "An [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details) was removed.", "properties": { "acs_entrance_id": { "description": "ID of the affected entrance.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "acs_entrance.removed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "acs_system_id", "acs_entrance_id", "event_type" ], "type": "object", "x-route-path": "/acs/entrances" }, { "description": "A client session was deleted.", "properties": { "client_session_id": { "description": "ID of the affected client session.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "client_session.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "client_session_id", "event_type" ], "type": "object", "x-route-path": "/client_sessions" }, { "description": "A connected account was connected for the first time or was reconnected after being disconnected.", "properties": { "connect_webview_id": { "description": "ID of the Connect Webview associated with the event.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with this connected account, if any.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.connected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account was created.", "properties": { "connect_webview_id": { "description": "ID of the Connect Webview associated with the event.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connect_webview_id" ], "type": "object", "x-route-path": "/connected_accounts" }, { "deprecated": true, "description": "Deprecated. Use `connect_webview.login_succeeded`.\n\nA connected account had a successful login using a Connect Webview.", "properties": { "connect_webview_id": { "description": "ID of the Connect Webview associated with the event.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.successful_login" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connect_webview_id" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account was disconnected.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.disconnected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.completed_first_sync" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account was deleted.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "connected_account_type": { "description": "undocumented: Unreleased.", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with this connected account, if any.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.completed_first_sync_after_reconnection" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the affected connected account.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connected_account.reauthorization_requested" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings" ], "type": "object", "x-route-path": "/connected_accounts" }, { "description": "A lock door action attempt succeeded.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.lock_door.succeeded" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A lock door action attempt failed.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.lock_door.failed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "An unlock door action attempt succeeded.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.unlock_door.succeeded" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "An unlock door action attempt failed.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.unlock_door.failed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A simulate keypad code entry action attempt succeeded.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.simulate_keypad_code_entry.succeeded" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A simulate keypad code entry action attempt failed.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.simulate_keypad_code_entry.failed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A simulate manual lock via keypad action attempt succeeded.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.simulate_manual_lock_via_keypad.succeeded" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A simulate manual lock via keypad action attempt failed.", "properties": { "action_attempt_id": { "description": "ID of the affected action attempt.", "format": "uuid", "type": "string" }, "action_type": { "description": "Type of the action.", "type": "string" }, "connected_account_id": { "description": "ID of the connected account associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device associated with the action attempt, if applicable.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "action_attempt.simulate_manual_lock_via_keypad.failed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the action.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "action_attempt_id", "action_type", "status", "event_type" ], "type": "object", "x-route-path": "/action_attempts" }, { "description": "A Connect Webview login succeeded.", "properties": { "connect_webview_id": { "description": "ID of the affected Connect Webview.", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account; present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with this connect webview, if any.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connect_webview.login_succeeded" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connect_webview_id", "event_type", "connected_account_id" ], "type": "object", "x-route-path": "/connect_webviews" }, { "description": "A Connect Webview login failed.", "properties": { "connect_webview_id": { "description": "ID of the affected Connect Webview.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "connect_webview.login_failed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connect_webview_id", "event_type" ], "type": "object", "x-route-path": "/connect_webviews" }, { "description": "The status of a device changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.connected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A device was added to Seam or was re-added to Seam after having been removed.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.added" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A managed device was successfully converted to an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices).", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.converted_to_unmanaged" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "An [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.unmanaged.converted_to_managed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices/unmanaged" }, { "description": "The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.unmanaged.connected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices/unmanaged" }, { "description": "The status of a device changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "error_code": { "description": "Error code associated with the disconnection event, if any.", "enum": [ "account_disconnected", "hub_disconnected", "device_disconnected" ], "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.disconnected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "error_code", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "type": "object", "x-route-path": "/devices" }, { "description": "The status of an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "error_code": { "description": "Error code associated with the disconnection event, if any.", "enum": [ "account_disconnected", "hub_disconnected", "device_disconnected" ], "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.unmanaged.disconnected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "error_code", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "type": "object", "x-route-path": "/devices/unmanaged" }, { "description": "A device detected that it was tampered with, for example, opened or moved.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.tampered" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A device battery level dropped below the low threshold.", "properties": { "battery_level": { "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.low_battery" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "battery_level" ], "type": "object", "x-route-path": "/devices" }, { "description": "A device battery status changed since the last `battery_status_changed` event.", "properties": { "battery_level": { "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "battery_status": { "description": "Battery status of the affected device, calculated from the numeric `battery_level` value.", "enum": [ "critical", "low", "good", "full" ], "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.battery_status_changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "battery_status", "battery_level" ], "type": "object", "x-route-path": "/devices" }, { "description": "A device was removed externally from the connected account.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.removed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A device was deleted.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_name": { "description": "Name of the deleted device, captured at deletion time. The device record no longer exists when this event fires, so the name is preserved here. Null when the device had no resolvable name.", "nullable": true, "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "Seam detected that a device is using a third-party integration that will interfere with Seam device management.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.third_party_integration_detected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.third_party_integration_no_longer_detected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A [Salto device](/device-and-system-integration-guides/salto-locks) activated privacy mode.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.salto.privacy_mode_activated" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A [Salto device](/device-and-system-integration-guides/salto-locks) deactivated privacy mode.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.salto.privacy_mode_deactivated" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "Seam detected a flaky device connection.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.connection_became_flaky" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "type": "object", "x-route-path": "/devices" }, { "description": "Seam detected that a previously-flaky device connection stabilized.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.connection_stabilized" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "A third-party subscription is required to use all device features.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.error.subscription_required" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "type": "object", "x-route-path": "/devices" }, { "description": "A third-party subscription is active or no longer required to use all device features.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.error.subscription_required.resolved" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "An accessory keypad was connected to a device.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.accessory_keypad_connected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "An accessory keypad was disconnected from a device.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_errors": { "description": "Errors associated with the connected account.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "connected_account_warnings": { "description": "Warnings associated with the connected account.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_errors": { "description": "Errors associated with the device.", "items": { "description": "Error associated with the resource, including the error code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object" }, "type": "array" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_warnings": { "description": "Warnings associated with the device.", "items": { "description": "Warning associated with the resource, including the warning code, message, and creation timestamp.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.accessory_keypad_disconnected" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "connected_account_errors", "connected_account_warnings", "device_errors", "device_warnings" ], "type": "object", "x-route-path": "/devices" }, { "description": "Extended periods of noise or noise exceeding a [threshold](/capability-guides/noise-sensors#what-is-a-threshold) were detected.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "noise_sensor.noise_threshold_triggered" ], "type": "string" }, "minut_metadata": { "additionalProperties": {}, "description": "Metadata from Minut.", "type": "object" }, "noise_level_decibels": { "description": "Detected noise level in decibels.", "format": "float", "type": "number" }, "noise_level_nrs": { "description": "Detected noise level in Noiseaware Noise Risk Score (NRS).", "format": "float", "type": "number" }, "noise_threshold_id": { "description": "ID of the noise threshold that was triggered.", "format": "uuid", "type": "string" }, "noise_threshold_name": { "description": "Name of the noise threshold that was triggered.", "type": "string" }, "noiseaware_metadata": { "additionalProperties": {}, "description": "Metadata from Noiseaware.", "type": "object" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/noise_sensors/noise_thresholds" }, { "description": "A [lock](/low-level-apis/smart-locks) was locked.", "properties": { "access_code_id": { "description": "ID of the access code that was used to lock the device.", "format": "uuid", "type": "string" }, "access_code_is_managed": { "description": "Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.", "type": "boolean" }, "action_attempt_id": { "description": "ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt).", "format": "uuid", "type": "string" }, "code": { "description": "\n Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "lock.locked" ], "type": "string" }, "is_via_bluetooth": { "description": "\n Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ", "type": "boolean" }, "is_via_nfc": { "description": "\n Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.\n ", "type": "boolean" }, "method": { "description": "Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined.", "enum": [ "keycode", "manual", "automatic", "unknown", "remote" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "method" ], "type": "object", "x-route-path": "/locks" }, { "description": "A [lock](/low-level-apis/smart-locks) was unlocked.", "properties": { "access_code_id": { "description": "ID of the access code that was used to unlock the affected device.", "format": "uuid", "type": "string" }, "access_code_is_managed": { "description": "Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.", "type": "boolean" }, "acs_entrance_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the unlock event.\n ", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the unlock event.\n ", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the unlock event.\n ", "format": "uuid", "type": "string" }, "action_attempt_id": { "description": "ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt).", "format": "uuid", "type": "string" }, "code": { "description": "\n Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "lock.unlocked" ], "type": "string" }, "is_via_bluetooth": { "description": "\n Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ", "type": "boolean" }, "is_via_nfc": { "description": "\n Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.\n ", "type": "boolean" }, "method": { "description": "Method by which the lock was unlocked. `keycode`: an [access code](/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined.", "enum": [ "keycode", "manual", "automatic", "unknown", "remote" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the unlock event.\n ", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type", "method" ], "type": "object", "x-route-path": "/locks" }, { "description": "The [lock](/low-level-apis/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.", "properties": { "access_code_id": { "description": "ID of the access code that was used in the unlock attempts.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the access-denied event.\n ", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the access-denied event.\n ", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the access-denied event.\n ", "format": "uuid", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "lock.access_denied" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "reason": { "description": "Why access was denied, when the provider reports a determinable cause. Omitted when unknown.", "properties": { "message": { "description": "Human-readable explanation of why access was denied.", "type": "string" }, "reason_code": { "description": "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.", "enum": [ "unknown_code", "expired_code", "blocklisted_code", "too_many_attempts", "blocked_by_privacy_mode", "credential_error" ], "type": "string" } }, "required": [ "reason_code", "message" ], "type": "object" }, "user_identity_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/locks" }, { "description": "A thermostat [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.", "properties": { "climate_preset_key": { "description": "Key of the climate preset that was activated.", "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.climate_preset_activated" ], "type": "string" }, "is_fallback_climate_preset": { "description": "Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.", "type": "boolean" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "thermostat_schedule_id": { "description": "ID of the thermostat schedule that prompted the affected climate preset to be activated.", "format": "uuid", "nullable": true, "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "thermostat_schedule_id", "climate_preset_key", "is_fallback_climate_preset" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "A [thermostat](/capability-guides/thermostats) was adjusted manually.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.manually_adjusted" ], "type": "string" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "method": { "description": "Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.", "enum": [ "seam", "external" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "method" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "A [thermostat's](/capability-guides/thermostats) temperature reading exceeded the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.temperature_threshold_exceeded" ], "type": "string" }, "lower_limit_celsius": { "description": "Lower temperature limit, in °C, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "lower_limit_fahrenheit": { "description": "Lower temperature limit, in °F, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "temperature_celsius": { "description": "Temperature, in °C, reported by the affected thermostat.", "format": "float", "type": "number" }, "temperature_fahrenheit": { "description": "Temperature, in °F, reported by the affected thermostat.", "format": "float", "type": "number" }, "upper_limit_celsius": { "description": "Upper temperature limit, in °C, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_fahrenheit": { "description": "Upper temperature limit, in °F, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit", "lower_limit_celsius", "lower_limit_fahrenheit" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "A [thermostat's](/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.temperature_threshold_no_longer_exceeded" ], "type": "string" }, "lower_limit_celsius": { "description": "Lower temperature limit, in °C, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "lower_limit_fahrenheit": { "description": "Lower temperature limit, in °F, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "temperature_celsius": { "description": "Temperature, in °C, reported by the affected thermostat.", "format": "float", "type": "number" }, "temperature_fahrenheit": { "description": "Temperature, in °F, reported by the affected thermostat.", "format": "float", "type": "number" }, "upper_limit_celsius": { "description": "Upper temperature limit, in °C, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_fahrenheit": { "description": "Upper temperature limit, in °F, defined by the set threshold.", "format": "float", "nullable": true, "type": "number" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit", "upper_limit_celsius", "upper_limit_fahrenheit", "lower_limit_celsius", "lower_limit_fahrenheit" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "desired_temperature_celsius": { "description": "Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point.", "format": "float", "type": "number" }, "desired_temperature_fahrenheit": { "description": "Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point.", "format": "float", "type": "number" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.temperature_reached_set_point" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "temperature_celsius": { "description": "Temperature, in °C, reported by the affected thermostat.", "format": "float", "type": "number" }, "temperature_fahrenheit": { "description": "Temperature, in °F, reported by the affected thermostat.", "format": "float", "type": "number" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "A [thermostat's](/capability-guides/thermostats) reported temperature changed by at least 1 °C.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "thermostat.temperature_changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "temperature_celsius": { "description": "Temperature, in °C, reported by the affected thermostat.", "format": "float", "type": "number" }, "temperature_fahrenheit": { "description": "Temperature, in °F, reported by the affected thermostat.", "format": "float", "type": "number" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "temperature_celsius", "temperature_fahrenheit" ], "type": "object", "x-route-path": "/thermostats" }, { "description": "The name of a device was changed.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "device_name": { "description": "The new name of the affected device.", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.name_changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "device_name" ], "type": "object", "x-route-path": "/devices" }, { "description": "A camera was activated, for example, by motion detection.", "properties": { "activation_reason": { "description": "The reason the camera was activated.", "enum": [ "motion_detected" ], "type": "string" }, "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "camera.activated" ], "type": "string" }, "image_url": { "description": "URL to a thumbnail image captured at the time of activation.", "format": "uri", "type": "string" }, "motion_sub_type": { "description": "Sub-type of motion detected, if available.", "enum": [ "human", "vehicle", "package", "other" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "video_url": { "description": "URL to a short video clip captured at the time of activation.", "format": "uri", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type", "activation_reason" ], "type": "object", "x-route-path": "/devices" }, { "description": "A doorbell button was pressed on a device.", "properties": { "connected_account_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the connected account, present when connected_account_id is provided.", "type": "object" }, "connected_account_id": { "description": "ID of the connected account associated with the event.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "The customer key associated with the device, if any.", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device, present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "device.doorbell_rang" ], "type": "string" }, "image_url": { "description": "URL to a thumbnail image captured at the time the doorbell was pressed.", "format": "uri", "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "video_url": { "description": "URL to a short video clip captured at the time the doorbell was pressed.", "format": "uri", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "connected_account_id", "event_type" ], "type": "object", "x-route-path": "/devices" }, { "description": "An [enrollment automation](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) was deleted.", "properties": { "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "enrollment_automation_id": { "description": "ID of the affected enrollment automation.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "enrollment_automation.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "enrollment_automation_id", "event_type" ], "type": "object", "x-route-path": "/user_identities/enrollment_automations" }, { "description": "A phone device was deactivated.", "properties": { "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata of the device; present when device_id is provided.", "type": "object" }, "device_id": { "description": "ID of the affected phone device.", "format": "uuid", "type": "string" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "enum": [ "phone.deactivated" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "device_id", "event_type" ], "type": "object", "x-route-path": "/phones" }, { "description": "A device was added or removed from a space.", "properties": { "acs_entrance_ids": { "description": "IDs of all ACS entrances currently attached to the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_ids": { "description": "IDs of all devices currently attached to the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "description": "Type of the event.", "enum": [ "space.device_membership_changed" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "space_id": { "description": "ID of the affected space.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key for the space within the workspace.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "type": "object", "x-route-path": "/spaces" }, { "description": "A space was created.", "properties": { "acs_entrance_ids": { "description": "IDs of all ACS entrances attached to the space when it was created.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_ids": { "description": "IDs of all devices attached to the space when it was created.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "description": "Type of the event.", "enum": [ "space.created" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "space_id": { "description": "ID of the affected space.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key for the space within the workspace.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "type": "object", "x-route-path": "/spaces" }, { "description": "A space was deleted.", "properties": { "acs_entrance_ids": { "description": "IDs of all ACS entrances currently attached to the space when it was deleted.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the event was created.", "format": "date-time", "type": "string" }, "device_ids": { "description": "IDs of all devices attached to the space when it was deleted.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "event_description": { "description": "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.", "type": "string" }, "event_id": { "description": "ID of the event.", "format": "uuid", "type": "string" }, "event_type": { "description": "Type of the event.", "enum": [ "space.deleted" ], "type": "string" }, "occurred_at": { "description": "Date and time at which the event occurred.", "format": "date-time", "type": "string" }, "space_id": { "description": "ID of the affected space.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key for the space within the workspace.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the event.", "format": "uuid", "type": "string" } }, "required": [ "event_id", "workspace_id", "created_at", "occurred_at", "space_id", "event_type", "device_ids", "acs_entrance_ids" ], "type": "object", "x-route-path": "/spaces" } ], "x-route-path": "/events" }, "instant_key": { "description": "Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app. See the [instant_key object](/api/instant_keys/object).", "properties": { "client_session_id": { "description": "ID of the client session associated with the Instant Key.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the Instant Key was created.", "format": "date-time", "type": "string" }, "customization": { "description": "Customization applied to the Instant Key UI.", "properties": { "logo_url": { "description": "URL of the logo displayed on the Instant Key.", "format": "uri", "type": "string" }, "primary_color": { "description": "Primary color used in the Instant Key UI.", "type": "string" }, "secondary_color": { "description": "Secondary color used in the Instant Key UI.", "type": "string" } }, "type": "object" }, "customization_profile_id": { "description": "ID of the customization profile associated with the Instant Key.", "format": "uuid", "type": "string" }, "expires_at": { "description": "Date and time at which the Instant Key expires.", "format": "date-time", "type": "string" }, "instant_key_id": { "description": "ID of the Instant Key.", "format": "uuid", "type": "string" }, "instant_key_url": { "description": "Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app.", "format": "uri", "type": "string" }, "user_identity_id": { "description": "ID of the user identity associated with the Instant Key.", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the Instant Key.", "format": "uuid", "type": "string" } }, "required": [ "instant_key_id", "workspace_id", "created_at", "instant_key_url", "client_session_id", "user_identity_id", "expires_at" ], "type": "object", "x-route-path": "/instant_keys" }, "magic_link": { "description": "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.", "properties": { "created_at": { "description": "Date and time at which the magic link was created.", "format": "date-time", "type": "string" }, "customer_key": { "description": "Customer key for the magic link.", "type": "string" }, "expires_at": { "description": "Date and time at which the magic link expires.", "format": "date-time", "type": "string" }, "url": { "description": "URL for the magic link.", "format": "uri", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the magic link.", "format": "uuid", "type": "string" } }, "required": [ "url", "customer_key", "expires_at", "workspace_id", "created_at" ], "type": "object", "x-route-path": "/unstable_partner/building_blocks" }, "noise_threshold": { "description": "Represents a [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 default thresholds, but you can use the Seam API to modify them. See the [noise_threshold object](/api/noise_sensors/noise_thresholds/object).", "properties": { "device_id": { "description": "Unique identifier for the device that contains the noise threshold.", "format": "uuid", "type": "string" }, "ends_daily_at": { "description": "Time at which the noise threshold should become inactive daily.", "type": "string" }, "name": { "description": "Name of the noise threshold.", "type": "string" }, "noise_threshold_decibels": { "description": "Noise level in decibels for the noise threshold.", "format": "float", "type": "number" }, "noise_threshold_id": { "description": "Unique identifier for the noise threshold.", "format": "uuid", "type": "string" }, "noise_threshold_nrs": { "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](/device-and-system-integration-guides/noiseaware-sensors).", "format": "float", "type": "number" }, "starts_daily_at": { "description": "Time at which the noise threshold should become active daily.", "type": "string" } }, "required": [ "noise_threshold_id", "device_id", "name", "starts_daily_at", "ends_daily_at", "noise_threshold_decibels" ], "type": "object", "x-route-path": "/noise_sensors/noise_thresholds" }, "pagination": { "description": "Information about the current page of results.", "properties": { "has_next_page": { "description": "Indicates whether there is another page of results after this one.", "type": "boolean" }, "next_page_cursor": { "description": "Opaque value that can be used to select the next page of results via the `page_cursor` parameter.", "nullable": true, "type": "string" }, "next_page_url": { "description": "URL to get the next page of results.", "format": "uri", "nullable": true, "type": "string" } }, "required": [ "next_page_cursor", "has_next_page", "next_page_url" ], "type": "object" }, "phone": { "description": "Represents an app user's mobile phone. See the [phone object](/api/phones/object).", "properties": { "created_at": { "description": "Date and time at which the phone was created.\n ", "format": "date-time", "type": "string" }, "custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Optional [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.\n ", "type": "object" }, "device_id": { "description": "ID of the phone.\n ", "format": "uuid", "type": "string" }, "device_type": { "description": "Type of the phone device, such as `ios_phone` or `android_phone`.", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, "display_name": { "description": "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.\n ", "type": "string" }, "errors": { "description": "Errors associated with the phone.", "items": { "properties": { "error_code": { "description": "Unique identifier of the type of error.", "type": "string" }, "message": { "description": "Detailed description of the error.", "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "nickname": { "description": "Optional nickname to describe the phone, settable through Seam.\n ", "type": "string" }, "properties": { "description": "Properties of the phone.", "properties": { "assa_abloy_credential_service_metadata": { "description": "ASSA ABLOY Credential Service metadata for the phone.", "properties": { "endpoints": { "description": "Endpoints associated with the phone.", "items": { "properties": { "endpoint_id": { "description": "ID of the associated endpoint.", "type": "string" }, "is_active": { "description": "Indicated whether the endpoint is active.", "type": "boolean" } }, "type": "object" }, "type": "array" }, "has_active_endpoint": { "description": "Indicates whether the credential service has active endpoints associated with the phone.", "type": "boolean" } }, "type": "object" }, "salto_space_credential_service_metadata": { "description": "Salto Space credential service metadata for the phone.", "properties": { "has_active_phone": { "description": "Indicates whether the credential service has an active associated phone.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "warnings": { "description": "Warnings associated with the phone.", "items": { "properties": { "message": { "description": "Detailed description of the warning.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning.", "type": "string" } }, "required": [ "warning_code", "message" ], "type": "object" }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the phone.\n ", "format": "uuid", "type": "string" } }, "required": [ "device_id", "display_name", "workspace_id", "created_at", "custom_metadata", "errors", "warnings", "device_type", "properties" ], "type": "object", "x-property-groups": { "phones": { "name": "Phones" } }, "x-route-path": "/phones" }, "phone_registration": { "description": "Represents a mobile phone registration.", "properties": { "is_being_activated": { "description": "Indicates whether the phone is being activated.", "type": "boolean" }, "phone_registration_id": { "description": "Registration ID for the phone.", "type": "string" }, "provider_name": { "description": "Provider name for the phone.", "nullable": true, "type": "string" }, "provider_state": { "description": "Provider state for the phone." } }, "required": [ "phone_registration_id", "provider_name", "is_being_activated" ], "type": "object", "x-route-path": "/seam/mobile_sdk/v1/phone_sessions" }, "phone_session": { "description": "Represents a mobile phone session.", "properties": { "is_sandbox_workspace": { "description": "Whether the workspace is in sandbox mode.", "type": "boolean" }, "provider_sessions": { "description": "Phone provider sessions.", "items": { "description": "Phone provider session.", "properties": { "acs_credentials": { "description": "Access system credentials associated with the phone provider session.", "items": { "description": "Means by which an [access control system user](/low-level-apis/access-systems/user-management) gains access at an [entrance](/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.", "properties": { "access_method": { "description": "Access method for the [credential](/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "acs_credential_id": { "nullable": true, "type": "string" }, "acs_credential_pool_id": { "description": "ID of the credential pool to which the credential belongs.", "format": "uuid", "type": "string" }, "acs_entrances": { "items": { "description": "Represents an [entrance](/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](/low-level-apis/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.", "properties": { "acs_entrance_id": { "description": "ID of the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "assa_abloy_vostio_metadata": { "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "door_name": { "description": "Name of the door in the Vostio access system.", "type": "string" }, "door_number": { "description": "Number of the door in the Vostio access system.", "format": "float", "type": "number" }, "door_type": { "description": "Type of the door in the Vostio access system.", "enum": [ "CommonDoor", "EntranceDoor", "GuestDoor", "Elevator" ], "type": "string" }, "pms_id": { "description": "PMS ID of the door in the Vostio access system.", "type": "string" }, "stand_open": { "description": "Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.", "type": "boolean" } }, "type": "object" }, "avigilon_alta_metadata": { "description": "Avigilon Alta-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "entry_name": { "description": "Entry name for an Avigilon Alta system.", "type": "string" }, "entry_relays_total_count": { "description": "Total count of entry relays for an Avigilon Alta system.", "format": "float", "type": "number" }, "org_name": { "description": "Organization name for an Avigilon Alta system.", "type": "string" }, "site_id": { "description": "Site ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "site_name": { "description": "Site name for an Avigilon Alta system.", "type": "string" }, "zone_id": { "description": "Zone ID for an Avigilon Alta system.", "format": "float", "type": "number" }, "zone_name": { "description": "Zone name for an Avigilon Alta system.", "type": "string" } }, "type": "object" }, "brivo_metadata": { "description": "Brivo-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_id": { "description": "ID of the access point in the Brivo access system.", "type": "string" }, "site_id": { "description": "ID of the site that the access point belongs to.", "format": "float", "type": "number" }, "site_name": { "description": "Name of the site that the access point belongs to.", "type": "string" } }, "type": "object" }, "can_belong_to_reservation": { "description": "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.", "type": "boolean" }, "can_unlock_with_card": { "description": "Indicates whether the ACS entrance can be unlocked with card credentials.", "type": "boolean" }, "can_unlock_with_cloud_key": { "description": "Indicates whether the ACS entrance can be unlocked with cloud key credentials.", "type": "boolean" }, "can_unlock_with_code": { "description": "Indicates whether the ACS entrance can be unlocked with pin codes.", "type": "boolean" }, "can_unlock_with_mobile_key": { "description": "Indicates whether the ACS entrance can be unlocked with mobile key credentials.", "type": "boolean" }, "connected_account_id": { "description": "ID of the [connected account](/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [entrance](/low-level-apis/access-systems/retrieving-entrance-details) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "type": "string" }, "dormakaba_ambiance_metadata": { "description": "dormakaba Ambiance-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_name": { "description": "Name of the access point in the dormakaba Ambiance access system.", "type": "string" } }, "type": "object" }, "dormakaba_community_metadata": { "description": "dormakaba Community-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "access_point_profile": { "description": "Type of access point profile in the dormakaba Community access system.", "type": "string" } }, "type": "object" }, "errors": { "description": "Errors associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "items": { "properties": { "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "hotek_metadata": { "description": "Hotek-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "common_area_name": { "description": "Display name of the entrance.", "type": "string" }, "common_area_number": { "description": "Display name of the entrance.", "type": "string" }, "room_number": { "description": "Room number of the entrance.", "type": "string" } }, "type": "object" }, "is_locked": { "description": "Indicates whether the [entrance](/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.", "type": "boolean" }, "latch_metadata": { "description": "Latch-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "accessibility_type": { "description": "Accessibility type in the Latch access system.", "type": "string" }, "door_name": { "description": "Name of the door in the Latch access system.", "type": "string" }, "door_type": { "description": "Type of the door in the Latch access system.", "type": "string" }, "is_connected": { "description": "Indicates whether the entrance is connected.", "type": "boolean" } }, "type": "object" }, "salto_ks_metadata": { "description": "Salto KS-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "battery_level": { "description": "Battery level of the door access device.", "type": "string" }, "door_name": { "description": "Name of the door in the Salto KS access system.", "type": "string" }, "intrusion_alarm": { "description": "Indicates whether an intrusion alarm is active on the door.", "type": "boolean" }, "left_open_alarm": { "description": "Indicates whether the door is left open.", "type": "boolean" }, "lock_type": { "description": "Type of the lock in the Salto KS access system.", "type": "string" }, "locked_state": { "description": "Locked state of the door in the Salto KS access system.", "type": "string" }, "online": { "description": "Indicates whether the door access device is online.", "type": "boolean" }, "privacy_mode": { "description": "Indicates whether privacy mode is enabled for the lock.", "type": "boolean" } }, "type": "object" }, "salto_space_metadata": { "description": "Salto Space-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "audit_on_keys": { "description": "Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.", "type": "boolean" }, "door_description": { "description": "Description of the door in the Salto Space access system.", "type": "string" }, "door_id": { "description": "Door ID in the Salto Space access system.", "type": "string" }, "door_name": { "description": "Name of the door in the Salto Space access system.", "type": "string" }, "room_description": { "description": "Description of the room in the Salto Space access system.", "type": "string" }, "room_name": { "description": "Name of the room in the Salto Space access system.", "type": "string" } }, "type": "object" }, "space_ids": { "description": "IDs of the spaces that the entrance is in.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "visionline_metadata": { "description": "Visionline-specific metadata associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "properties": { "door_category": { "description": "Category of the door in the Visionline access system.", "enum": [ "entrance", "guest", "elevator reader", "common", "common (PMS)" ], "type": "string" }, "door_name": { "description": "Name of the door in the Visionline access system.", "type": "string" }, "profiles": { "description": "Profile for the door in the Visionline access system.", "items": { "properties": { "visionline_door_profile_id": { "description": "Door profile ID in the Visionline access system.", "type": "string" }, "visionline_door_profile_type": { "description": "Door profile type in the Visionline access system.", "enum": [ "BLE", "commonDoor", "touch" ], "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "warnings": { "description": "Warnings associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "items": { "description": "Warning associated with the [entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "salto_ks_entrance_access_code_support_removed" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "entrance_shares_zone" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "entrance_setup_required" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "salto_ks_privacy_mode" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "privacy_mode" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" } }, "required": [ "acs_system_id", "acs_entrance_id", "space_ids", "created_at", "display_name", "connected_account_id", "errors", "warnings" ], "type": "object", "x-route-path": "/acs/entrances" }, "type": "array" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the [ACS user](/low-level-apis/access-systems/user-management) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "assa_abloy_vostio_metadata": { "description": "Vostio-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "door_names": { "description": "Names of the doors to which to grant access in the Vostio access system.", "items": { "type": "string" }, "type": "array" }, "endpoint_id": { "description": "Endpoint ID in the Vostio access system.", "type": "string" }, "key_id": { "description": "Key ID in the Vostio access system.", "type": "string" }, "key_issuing_request_id": { "description": "Key issuing request ID in the Vostio access system.", "type": "string" }, "override_guest_acs_entrance_ids": { "description": "IDs of the guest entrances to override in the Vostio access system.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "card_number": { "description": "Number of the card associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "code": { "description": "Access (PIN) code for the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "connected_account_id": { "description": "ID of the [connected account](/core-concepts/connected-accounts) to which the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name that corresponds to the [credential](/low-level-apis/access-systems/managing-credentials) type.", "minLength": 1, "type": "string" }, "ends_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "errors": { "description": "Errors associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "external_type": { "description": "Brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", "enum": [ "pti_card", "brivo_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card", "salto_ks_tag", "avigilon_alta_credential", "kisi_credential" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type.", "type": "string" }, "is_issued": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.", "type": "boolean" }, "is_latest_desired_state_synced_with_provider": { "description": "Indicates whether the latest state of the [credential](/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.", "nullable": true, "type": "boolean" }, "is_managed": { "description": "Indicates whether Seam manages the credential.", "enum": [ true ], "type": "boolean" }, "is_multi_phone_sync_credential": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was encoded onto a card.", "format": "date-time", "nullable": true, "type": "string" }, "latest_desired_state_synced_with_provider_at": { "description": "Date and time at which the state of the [credential](/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.", "format": "date-time", "nullable": true, "type": "string" }, "parent_acs_credential_id": { "description": "ID of the parent [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "starts_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/api/user_identities/object) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "visionline_metadata": { "description": "Visionline-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "card_function_type": { "description": "Card function type in the Visionline access system.", "enum": [ "guest", "staff" ], "type": "string" }, "card_id": { "description": "ID of the card in the Visionline access system.", "type": "string" }, "common_acs_entrance_ids": { "description": "Common entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "credential_id": { "description": "ID of the credential in the Visionline access system.", "type": "string" }, "guest_acs_entrance_ids": { "description": "Guest entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_valid": { "description": "Indicates whether the credential is valid.", "type": "boolean" }, "joiner_acs_credential_ids": { "description": "IDs of the credentials to which you want to join.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "warnings": { "description": "Warnings associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "description": "Warning associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [credential](/low-level-apis/access-systems/managing-credentials) is waiting to be issued.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "waiting_to_be_issued" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the schedule of one of the [credential](/low-level-apis/access-systems/managing-credentials)'s children was modified externally.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "schedule_externally_modified" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the schedule of the [credential](/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "schedule_modified" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the [credential](/low-level-apis/access-systems/managing-credentials) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "An unknown issue occurred while syncing the state of the [credential](/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "unknown_issue_with_acs_credential" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Access permissions for the [credential](/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "needs_to_be_reissued" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed", "acs_credential_id", "acs_entrances" ], "type": "object", "x-route-path": "/acs/credentials" }, "type": "array" } }, "required": [ "acs_credentials" ], "type": "object" }, "type": "array" }, "user_identity": { "description": "User identity.", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "user_identity_key", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object" }, "workspace_id": { "description": "Workspace ID.", "type": "string" } }, "required": [ "provider_sessions", "user_identity", "workspace_id", "is_sandbox_workspace" ], "type": "object", "x-route-path": "/seam/mobile_sdk/v1/phone_sessions" }, "space": { "description": "Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. See the [space object](/api/spaces/object).", "properties": { "acs_entrance_count": { "description": "Number of entrances in the space.", "format": "float", "type": "number" }, "created_at": { "description": "Date and time at which the space was created.", "format": "date-time", "type": "string" }, "customer_data": { "additionalProperties": { "nullable": true, "type": "string" }, "description": "Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam).", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "customer_key": { "description": "Customer key associated with the space.", "type": "string" }, "device_count": { "description": "Number of devices in the space.", "format": "float", "type": "number" }, "display_name": { "description": "Display name for the space.", "type": "string" }, "geolocation": { "description": "Geographic coordinates (latitude and longitude) of the space.", "nullable": true, "properties": { "latitude": { "description": "Latitude of the space, in decimal degrees.", "format": "float", "type": "number" }, "longitude": { "description": "Longitude of the space, in decimal degrees.", "format": "float", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "name": { "description": "Name of the space.", "type": "string" }, "space_id": { "description": "ID of the space.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key for the space within the workspace.", "type": "string" }, "workspace_id": { "description": "ID of the workspace associated with the space.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "workspace_id", "name", "display_name", "created_at", "device_count", "acs_entrance_count" ], "type": "object", "x-route-path": "/spaces" }, "staff_member": { "description": "Represents a staff member for a specific customer.", "properties": { "building_keys": { "description": "List of unique identifiers for the buildings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "List of unique identifiers for the common areas the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "facility_keys": { "description": "List of unique identifiers for the facilities the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "listing_keys": { "description": "List of unique identifiers for the listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "property_keys": { "description": "List of unique identifiers for the properties the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "property_listing_keys": { "description": "List of unique identifiers for the property listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "room_keys": { "description": "List of unique identifiers for the rooms the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "site_keys": { "description": "List of unique identifiers for the sites the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "List of unique identifiers for the spaces the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "staff_member_key": { "description": "Your unique identifier for the staff.", "type": "string" }, "unit_keys": { "description": "List of unique identifiers for the units the staff member is associated with.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "staff_member_key" ], "type": "object", "x-route-path": "/seam/customer/v1/staff_members" }, "thermostat_daily_program": { "description": "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time. See the [thermostat_daily_program object](/api/thermostats/daily_programs/object).", "properties": { "created_at": { "description": "Date and time at which the thermostat daily program was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the thermostat device on which the thermostat daily program is configured.", "format": "uuid", "type": "string" }, "name": { "description": "User-friendly name to identify the thermostat daily program.", "nullable": true, "type": "string" }, "periods": { "description": "Array of thermostat daily program periods.", "items": { "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.", "type": "string" }, "starts_at_time": { "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "type": "string" } }, "required": [ "starts_at_time", "climate_preset_key" ], "type": "object" }, "type": "array" }, "thermostat_daily_program_id": { "description": "ID of the thermostat daily program.", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the thermostat daily program.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_daily_program_id", "device_id", "name", "periods", "workspace_id", "created_at" ], "type": "object", "x-route-path": "/thermostats/daily_programs" }, "thermostat_schedule": { "description": "Represents a [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. See the [thermostat_schedule object](/api/thermostats/schedules/object).", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "type": "string" }, "created_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the desired [thermostat](/capability-guides/thermostats) device.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "errors": { "description": "Errors associated with the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "items": { "properties": { "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "is_override_allowed": { "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.", "type": "boolean" }, "max_override_period_minutes": { "description": "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "exclusiveMinimum": true, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "description": "User-friendly name to identify the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "thermostat_schedule_id": { "description": "ID of the [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "format": "uuid", "type": "string" }, "workspace_id": { "description": "ID of the workspace that contains the thermostat schedule.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id", "device_id", "name", "climate_preset_key", "starts_at", "ends_at", "workspace_id", "created_at", "errors" ], "type": "object", "x-route-path": "/thermostats/schedules" }, "unmanaged_access_code": { "description": "Represents an [unmanaged smart lock access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). See the [unmanaged_access_code object](/api/access_codes/unmanaged/object).", "properties": { "access_code_id": { "description": "Unique identifier for the access code.", "format": "uuid", "type": "string" }, "cannot_be_managed": { "description": "Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.", "enum": [ true ], "type": "boolean" }, "cannot_delete_unmanaged_access_code": { "description": "Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.", "enum": [ true ], "type": "boolean" }, "code": { "description": "Code used for access. Typically, a numeric or alphanumeric string.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access code was created.", "format": "date-time", "type": "string" }, "device_id": { "description": "Unique identifier for the device associated with the access code.", "format": "uuid", "type": "string" }, "dormakaba_oracode_metadata": { "description": "Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.", "nullable": true, "properties": { "is_cancellable": { "description": "Indicates whether the stay can be cancelled via the Dormakaba Oracode API.", "type": "boolean" }, "is_early_checkin_able": { "description": "Indicates whether early check-in is available for this stay.", "type": "boolean" }, "is_extendable": { "description": "Indicates whether the stay can be extended via the Dormakaba Oracode API.", "type": "boolean" }, "is_overridable": { "description": "Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.", "type": "boolean" }, "site_name": { "description": "Dormakaba Oracode site name associated with this access code.", "type": "string" }, "stay_id": { "description": "Dormakaba Oracode stay ID associated with this access code.", "format": "float", "type": "number" }, "user_level_id": { "description": "Dormakaba Oracode user level ID associated with this access code.", "type": "string" }, "user_level_name": { "description": "Dormakaba Oracode user level name associated with this access code.", "nullable": true, "type": "string" } }, "type": "object" }, "ends_at": { "description": "Date and time after which the time-bound access code becomes inactive.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "type": "array", "description": "Errors associated with the [access code](/low-level-apis/smart-locks/access-codes).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "is_managed": { "description": "Indicates that Seam does not manage the access code.", "enum": [ false ], "type": "boolean" }, "name": { "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the time-bound access code becomes active.", "format": "date-time", "nullable": true, "type": "string" }, "status": { "description": "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.", "enum": [ "set", "unset" ], "type": "string" }, "type": { "description": "Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.", "enum": [ "time_bound", "ongoing" ], "type": "string" }, "warnings": { "type": "array", "description": "Warnings associated with the [access code](/low-level-apis/smart-locks/access-codes).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "Unique identifier for the Seam workspace associated with the access code.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "type", "access_code_id", "device_id", "name", "code", "created_at", "errors", "warnings", "is_managed", "status" ], "type": "object", "x-route-path": "/access_codes/unmanaged" }, "unmanaged_acs_access_group": { "properties": { "access_group_type": { "deprecated": true, "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group", "avigilon_alta_group", "kisi_access_group" ], "type": "string", "description": "Deprecated. Use `external_type`." }, "access_group_type_display_name": { "deprecated": true, "type": "string", "description": "Deprecated. Use `external_type_display_name`." }, "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access group's access.", "properties": { "ends_at": { "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_access_group_id": { "description": "ID of the access group.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access control system that contains the access group.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account that contains the access group.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the access group was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the access group.", "type": "string" }, "errors": { "description": "Errors associated with the `acs_access_group`.", "items": { "description": "Error associated with the `acs_access_group`.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that the [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "failed_to_create_on_acs_system" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "acs_access_group" } ] }, "type": "array" }, "external_type": { "description": "Brand-specific terminology for the access group type.", "enum": [ "pti_unit", "pti_access_level", "salto_ks_access_group", "brivo_group", "salto_space_group", "dormakaba_community_access_group", "dormakaba_ambiance_access_group", "avigilon_alta_group", "kisi_access_group" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the access group type.", "type": "string" }, "is_managed": { "enum": [ false ], "type": "boolean" }, "name": { "description": "Name of the access group.", "type": "string" }, "pending_mutations": { "description": "Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of pushing an access group creation to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.", "enum": [ "creating" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group deletion to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.", "enum": [ "deleting" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "This access group is scheduled for automatic deletion when its access window expires.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.", "enum": [ "deferring_deletion" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group information update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access group information.", "properties": { "name": { "description": "Name of the access group.", "nullable": true, "type": "string" } }, "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.", "enum": [ "updating_group_information" ], "type": "string" }, "to": { "description": "New access group information.", "properties": { "name": { "description": "Name of the access group.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access schedule update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access schedule information.", "properties": { "ends_at": { "description": "Ending time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.", "enum": [ "updating_access_schedule" ], "type": "string" }, "to": { "description": "New access schedule information.", "properties": { "ends_at": { "description": "Ending time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing a user membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old user membership.", "properties": { "acs_user_id": { "description": "Old user ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.", "enum": [ "updating_user_membership" ], "type": "string" }, "to": { "description": "New user membership.", "properties": { "acs_user_id": { "description": "New user ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an entrance membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old entrance membership.", "properties": { "acs_entrance_id": { "description": "Old entrance ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.", "enum": [ "updating_entrance_membership" ], "type": "string" }, "to": { "description": "New entrance membership.", "properties": { "acs_entrance_id": { "description": "New entrance ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "A scheduled user membership change is pending for this access group.", "properties": { "acs_user_id": { "description": "ID of the user involved in the scheduled change.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that a scheduled user membership change is pending for this access group.", "enum": [ "deferring_user_membership_update" ], "type": "string" }, "variant": { "description": "Whether the user is scheduled to be added to or removed from this access group.", "enum": [ "adding", "removing" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code", "acs_user_id", "variant" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the `acs_access_group`.", "items": { "description": "Warning associated with the `acs_access_group`.", "oneOf": [ { "description": "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "unknown_issue_with_acs_access_group" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the access group.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id", "acs_system_id", "workspace_id", "connected_account_id", "name", "access_group_type", "access_group_type_display_name", "display_name", "external_type", "external_type_display_name", "created_at", "errors", "warnings", "pending_mutations", "is_managed" ], "type": "object", "x-route-path": "/acs/access_groups/unmanaged" }, "unmanaged_acs_credential": { "description": "Means by which an [ACS user](/low-level-apis/access-systems/user-management) gains access at an [entrance](/low-level-apis/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](/low-level-apis/access-systems).", "properties": { "access_method": { "description": "Access method for the [credential](/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "acs_credential_id": { "description": "ID of the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "acs_credential_pool_id": { "description": "ID of the credential pool to which the credential belongs.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the [access control system](/low-level-apis/access-systems) that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the [ACS user](/low-level-apis/access-systems/user-management) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "assa_abloy_vostio_metadata": { "description": "Vostio-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "door_names": { "description": "Names of the doors to which to grant access in the Vostio access system.", "items": { "type": "string" }, "type": "array" }, "endpoint_id": { "description": "Endpoint ID in the Vostio access system.", "type": "string" }, "key_id": { "description": "Key ID in the Vostio access system.", "type": "string" }, "key_issuing_request_id": { "description": "Key issuing request ID in the Vostio access system.", "type": "string" }, "override_guest_acs_entrance_ids": { "description": "IDs of the guest entrances to override in the Vostio access system.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "card_number": { "description": "Number of the card associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "code": { "description": "Access (PIN) code for the [credential](/low-level-apis/access-systems/managing-credentials).", "nullable": true, "type": "string" }, "connected_account_id": { "description": "ID of the [connected account](/core-concepts/connected-accounts) to which the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name that corresponds to the [credential](/low-level-apis/access-systems/managing-credentials) type.", "minLength": 1, "type": "string" }, "ends_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "errors": { "description": "Errors associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "error_code", "message" ], "type": "object" }, "type": "array" }, "external_type": { "description": "Brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", "enum": [ "pti_card", "brivo_credential", "hid_credential", "visionline_card", "salto_ks_credential", "assa_abloy_vostio_key", "salto_space_key", "latch_access", "dormakaba_ambiance_credential", "hotek_card", "salto_ks_tag", "avigilon_alta_credential", "kisi_credential" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [credential](/low-level-apis/access-systems/managing-credentials) type.", "type": "string" }, "is_issued": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.", "type": "boolean" }, "is_latest_desired_state_synced_with_provider": { "description": "Indicates whether the latest state of the [credential](/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.", "nullable": true, "type": "boolean" }, "is_managed": { "enum": [ false ], "type": "boolean" }, "is_multi_phone_sync_credential": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [credential](/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) was encoded onto a card.", "format": "date-time", "nullable": true, "type": "string" }, "latest_desired_state_synced_with_provider_at": { "description": "Date and time at which the state of the [credential](/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.", "format": "date-time", "nullable": true, "type": "string" }, "parent_acs_credential_id": { "description": "ID of the parent [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" }, "starts_at": { "description": "Date and time at which the [credential](/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/api/user_identities/object) to whom the [credential](/low-level-apis/access-systems/managing-credentials) belongs.", "format": "uuid", "type": "string" }, "visionline_metadata": { "description": "Visionline-specific metadata for the [credential](/low-level-apis/access-systems/managing-credentials).", "properties": { "auto_join": { "description": "Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.", "type": "boolean" }, "card_function_type": { "description": "Card function type in the Visionline access system.", "enum": [ "guest", "staff" ], "type": "string" }, "card_id": { "description": "ID of the card in the Visionline access system.", "type": "string" }, "common_acs_entrance_ids": { "description": "Common entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "credential_id": { "description": "ID of the credential in the Visionline access system.", "type": "string" }, "guest_acs_entrance_ids": { "description": "Guest entrance IDs in the Visionline access system.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_valid": { "description": "Indicates whether the credential is valid.", "type": "boolean" }, "joiner_acs_credential_ids": { "description": "IDs of the credentials to which you want to join.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "warnings": { "type": "array", "description": "Warnings associated with the [credential](/low-level-apis/access-systems/managing-credentials).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "ID of the workspace that contains the [credential](/low-level-apis/access-systems/managing-credentials).", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id", "connected_account_id", "acs_system_id", "display_name", "access_method", "created_at", "workspace_id", "errors", "warnings", "is_managed" ], "type": "object", "x-route-path": "/acs/credentials/unmanaged" }, "unmanaged_acs_user": { "description": "Represents an unmanaged [user](/low-level-apis/access-systems/user-management) in an [access system](/low-level-apis/access-systems).", "properties": { "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the [access system user's](/low-level-apis/access-systems/user-management) access.", "properties": { "ends_at": { "description": "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_system_id": { "description": "ID of the [access system](/low-level-apis/access-systems) that contains the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "\n The ID of the connected account that is associated with the [access system user](/low-level-apis/access-systems/user-management).\n ", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the [access system user](/low-level-apis/access-systems/user-management) was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the [access system user](/low-level-apis/access-systems/user-management).", "type": "string" }, "email": { "deprecated": true, "format": "email", "type": "string", "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", "format": "email", "type": "string" }, "errors": { "type": "array", "description": "Errors associated with the [access system user](/low-level-apis/access-systems/user-management).", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "external_type": { "description": "Brand-specific terminology for the [access system user](/low-level-apis/access-systems/user-management) type.", "enum": [ "pti_user", "brivo_user", "hid_credential_manager_user", "salto_site_user", "latch_user", "dormakaba_community_user", "salto_space_user", "avigilon_alta_user", "kisi_user" ], "type": "string" }, "external_type_display_name": { "description": "Display name that corresponds to the brand-specific terminology for the [access system user](/low-level-apis/access-systems/user-management) type.", "type": "string" }, "full_name": { "description": "Full name of the [access system user](/low-level-apis/access-systems/user-management).", "minLength": 1, "type": "string" }, "hid_acs_system_id": { "description": "ID of the HID access control system associated with the user.", "format": "uuid", "type": "string" }, "is_managed": { "enum": [ false ], "type": "boolean" }, "is_suspended": { "description": "Indicates whether the [access system user](/low-level-apis/access-systems/user-management) is currently [suspended](/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).", "type": "boolean" }, "pending_mutations": { "description": "Pending mutations associated with the [access system user](/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of pushing a user creation to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.", "enum": [ "creating" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "Seam is in the process of pushing a user deletion to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.", "enum": [ "deleting" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "description": "User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time.", "enum": [ "deferring_creation" ], "type": "string" }, "scheduled_at": { "description": "Optional: When the user creation is scheduled to occur.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "created_at", "message", "mutation_code" ], "type": "object" }, { "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access system user information.", "properties": { "email_address": { "description": "Email address of the access system user.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the access system user.", "nullable": true, "type": "string" }, "phone_number": { "description": "Phone number of the access system user.", "nullable": true, "type": "string" } }, "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.", "enum": [ "updating_user_information" ], "type": "string" }, "to": { "description": "New access system user information.", "properties": { "email_address": { "description": "Email address of the access system user.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the access system user.", "nullable": true, "type": "string" }, "phone_number": { "description": "Phone number of the access system user.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access schedule update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access schedule information.", "properties": { "ends_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.", "enum": [ "updating_access_schedule" ], "type": "string" }, "to": { "description": "New access schedule information.", "properties": { "ends_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting time for the access schedule.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing a suspension state update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old user suspension state information.", "properties": { "is_suspended": { "type": "boolean" } }, "required": [ "is_suspended" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.", "enum": [ "updating_suspension_state" ], "type": "string" }, "to": { "description": "New user suspension state information.", "properties": { "is_suspended": { "type": "boolean" } }, "required": [ "is_suspended" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of pushing an access group membership update to the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Old access group membership.", "properties": { "acs_access_group_id": { "description": "Old access group ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.", "enum": [ "updating_group_membership" ], "type": "string" }, "to": { "description": "New access group membership.", "properties": { "acs_access_group_id": { "description": "New access group ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "A scheduled access group membership change is pending for this user.", "properties": { "acs_access_group_id": { "description": "ID of the access group involved in the scheduled change.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that a scheduled access group membership change is pending for this user.", "enum": [ "deferring_group_membership_update" ], "type": "string" }, "variant": { "description": "Whether the user is scheduled to be added to or removed from the access group.", "enum": [ "adding", "removing" ], "type": "string" } }, "required": [ "created_at", "message", "mutation_code", "acs_access_group_id", "variant" ], "type": "object" }, { "description": "Seam is in the process of assigning or unassigning a credential to the user on the integrated access system.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous credential assignment.", "properties": { "acs_credential_id": { "description": "Previous credential ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of assigning or unassigning a credential to the user on the integrated access system.", "enum": [ "updating_credential_assignment" ], "type": "string" }, "to": { "description": "New credential assignment.", "properties": { "acs_credential_id": { "description": "New credential ID.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "phone_number": { "description": "Phone number of the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "type": "string" }, "salto_space_metadata": { "description": "Salto Space-specific metadata associated with the [access system user](/low-level-apis/access-systems/user-management).", "properties": { "audit_openings": { "description": "Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.", "type": "boolean" }, "user_id": { "description": "User ID in the Salto Space access system.", "type": "string" } }, "type": "object" }, "user_identity_email_address": { "description": "Email address of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "nullable": true, "type": "string" }, "user_identity_full_name": { "description": "Full name of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management).", "type": "string" }, "user_identity_phone_number": { "description": "Phone number of the user identity associated with the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "nullable": true, "type": "string" }, "warnings": { "description": "Warnings associated with the [access system user](/low-level-apis/access-systems/user-management).", "items": { "description": "Warnings associated with the [access system user](/low-level-apis/access-systems/user-management).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) is being deleted from the [access system](/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "salto_ks_user_not_subscribed" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "An unknown issue occurred while syncing the state of this [access system user](/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "unknown_issue_with_acs_user" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the [access system user](/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "enum": [ "latch_resident_user" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the [access system user](/low-level-apis/access-systems/user-management).", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id", "acs_system_id", "workspace_id", "created_at", "display_name", "warnings", "errors", "connected_account_id", "is_managed" ], "type": "object", "x-route-path": "/acs/users/unmanaged" }, "unmanaged_device": { "description": "Represents an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. See the [unmanaged_device object](/api/devices/unmanaged/object).", "properties": { "can_configure_auto_lock": { "description": "Indicates whether the lock supports configuring automatic locking.", "type": "boolean" }, "can_hvac_cool": { "description": "Indicates whether the thermostat supports cooling.", "type": "boolean" }, "can_hvac_heat": { "description": "Indicates whether the thermostat supports heating.", "type": "boolean" }, "can_hvac_heat_cool": { "description": "Indicates whether the thermostat supports simultaneous heating and cooling.", "type": "boolean" }, "can_program_offline_access_codes": { "description": "Indicates whether the device supports programming offline access codes.", "type": "boolean" }, "can_program_online_access_codes": { "description": "Indicates whether the device supports programming online access codes.", "type": "boolean" }, "can_program_thermostat_programs_as_different_each_day": { "description": "Indicates whether the thermostat supports different climate programs for each day of the week.", "type": "boolean" }, "can_program_thermostat_programs_as_same_each_day": { "description": "Indicates whether the thermostat supports a single climate program applied to every day.", "type": "boolean" }, "can_program_thermostat_programs_as_weekday_weekend": { "description": "Indicates whether the thermostat supports weekday/weekend climate programs.", "type": "boolean" }, "can_remotely_lock": { "description": "Indicates whether the device supports remote locking.", "type": "boolean" }, "can_remotely_unlock": { "description": "Indicates whether the device supports remote unlocking.", "type": "boolean" }, "can_run_thermostat_programs": { "description": "Indicates whether the thermostat supports running climate programs.", "type": "boolean" }, "can_simulate_connection": { "description": "Indicates whether the device supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_disconnection": { "description": "Indicates whether the device supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_hub_connection": { "description": "Indicates whether the hub supports simulating connection in a sandbox.", "type": "boolean" }, "can_simulate_hub_disconnection": { "description": "Indicates whether the hub supports simulating disconnection in a sandbox.", "type": "boolean" }, "can_simulate_paid_subscription": { "description": "Indicates whether the device supports simulating a paid subscription in a sandbox.", "type": "boolean" }, "can_simulate_removal": { "description": "Indicates whether the device supports simulating removal in a sandbox.", "type": "boolean" }, "can_turn_off_hvac": { "description": "Indicates whether the thermostat can be turned off.", "type": "boolean" }, "can_unlock_with_code": { "description": "Indicates whether the lock supports unlocking with an access code.", "type": "boolean" }, "capabilities_supported": { "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](/capability-guides/device-and-system-capabilities#capability-flags).\n ", "items": { "description": "\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](/capability-guides/device-and-system-capabilities#capability-flags).\n ", "enum": [ "access_code", "lock", "noise_detection", "thermostat", "battery", "phone" ], "type": "string" }, "type": "array" }, "connected_account_id": { "description": "Unique identifier for the account associated with the device.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which the device object was created.", "format": "date-time", "type": "string" }, "custom_metadata": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "device_id": { "description": "ID of the device.", "format": "uuid", "type": "string" }, "device_type": { "description": "Type of the device.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "errors": { "type": "array", "description": "Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "is_managed": { "description": "Indicates that Seam does not manage the device.", "enum": [ false ], "type": "boolean" }, "location": { "description": "Location information for the device.", "properties": { "location_name": { "description": "Name of the device location.\n ", "type": "string" }, "time_zone": { "description": "Time zone of the device location.\n ", "type": "string" }, "timezone": { "deprecated": true, "description": "Deprecated. Use `time_zone` instead.\n\nTime zone of the device location.", "type": "string" } }, "type": "object", "x-property-group-key": "hardware" }, "properties": { "description": "properties of the device.", "properties": { "accessory_keypad": { "description": "Accessory keypad properties and state.", "properties": { "battery": { "description": "Keypad battery properties.\n ", "properties": { "level": { "format": "float", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "level" ], "type": "object" }, "is_connected": { "description": "Indicates if an accessory keypad is connected to the device.\n ", "type": "boolean" } }, "required": [ "is_connected" ], "type": "object", "x-property-group-key": "hardware" }, "battery": { "description": "Represents the current status of the battery charge level.", "properties": { "level": { "description": "Battery charge level as a value between 0 and 1, inclusive.\n ", "format": "float", "maximum": 1, "minimum": 0, "type": "number" }, "status": { "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ", "enum": [ "critical", "low", "good", "full" ], "type": "string" } }, "required": [ "level", "status" ], "type": "object", "x-property-group-key": "hardware" }, "battery_level": { "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", "format": "float", "maximum": 1, "minimum": 0, "type": "number", "x-property-group-key": "hardware" }, "image_alt_text": { "description": "Alt text for the device image.", "type": "string", "x-property-group-key": "hardware" }, "image_url": { "description": "Image URL for the device.", "format": "uri", "type": "string", "x-property-group-key": "hardware" }, "manufacturer": { "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "type": "string", "x-property-group-key": "hardware" }, "model": { "description": "Device model-related properties.", "properties": { "accessory_keypad_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "can_connect_accessory_keypad": { "description": "\n Indicates whether the device can connect a accessory keypad.\n ", "type": "boolean" }, "display_name": { "description": "\n Display name of the device model.\n ", "type": "string" }, "has_built_in_keypad": { "description": "\n Indicates whether the device has a built in accessory keypad.\n ", "type": "boolean" }, "manufacturer_display_name": { "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ", "type": "string" }, "offline_access_codes_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "deprecated": true, "type": "boolean", "description": "Deprecated. use device.can_program_online_access_codes." } }, "required": [ "display_name", "manufacturer_display_name" ], "type": "object" }, "name": { "deprecated": true, "description": "Deprecated. use device.display_name instead\n\nName of the device.", "type": "string" }, "offline_access_codes_enabled": { "deprecated": true, "description": "Deprecated. use device.can_program_offline_access_codes\n\nIndicates whether it is currently possible to use offline access codes for the device.", "type": "boolean", "x-property-group-key": "access_codes" }, "online": { "description": "Indicates whether the device is online.", "type": "boolean" }, "online_access_codes_enabled": { "deprecated": true, "description": "Deprecated. use device.can_program_online_access_codes\n\nIndicates whether it is currently possible to use online access codes for the device.", "type": "boolean", "x-property-group-key": "access_codes" } }, "required": [ "name", "online", "model" ], "type": "object", "x-property-groups": { "access_codes": { "name": "access codes" }, "hardware": { "name": "hardware" }, "locks": { "name": "locks" }, "noise_sensors": { "name": "noise sensors" }, "phones": { "name": "phones" }, "provider_metadata": { "name": "provider metadata" }, "thermostats": { "name": "thermostats" } } }, "warnings": { "type": "array", "description": "Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error or warning code." }, "message": { "type": "string", "description": "Human-readable description." }, "created_at": { "type": "string", "format": "date-time", "description": "When this error or warning was generated." } } } }, "workspace_id": { "description": "Unique identifier for the Seam workspace associated with the device.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "device_type", "connected_account_id", "capabilities_supported", "workspace_id", "errors", "warnings", "created_at", "custom_metadata", "is_managed", "properties" ], "type": "object", "x-property-groups": { "access_codes": { "name": "Access Codes" }, "hardware": { "name": "Hardware" }, "locks": { "name": "Locks" }, "noise_sensors": { "name": "Noise Sensors" }, "phones": { "name": "Phones" }, "provider_metadata": { "name": "Provider Metadata" }, "thermostats": { "name": "Thermostats" } }, "x-route-path": "/devices/unmanaged" }, "user_identity": { "description": "Represents a [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. See the [user_identity object](/api/user_identities/object).", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "user_identity_key", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object", "x-route-path": "/user_identities" }, "webhook": { "description": "Represents a [webhook](/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. See the [webhook object](/api/webhooks/object).", "properties": { "event_types": { "description": "Types of events that the [webhook](/developer-tools/webhooks) should receive.", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "Secret associated with the [webhook](/developer-tools/webhooks).", "type": "string" }, "url": { "description": "URL for the [webhook](/developer-tools/webhooks).", "type": "string" }, "webhook_id": { "description": "ID of the webhook.", "type": "string" } }, "required": [ "webhook_id", "url" ], "type": "object", "x-route-path": "/webhooks" }, "workspace": { "description": "Represents a Seam [workspace](/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. See the [workspace object](/api/workspaces/object).", "properties": { "company_name": { "description": "Company name associated with the [workspace](/core-concepts/workspaces).", "type": "string" }, "connect_partner_name": { "deprecated": true, "nullable": true, "type": "string", "description": "Deprecated. Use `company_name` instead." }, "connect_webview_customization": { "properties": { "inviter_logo_url": { "description": "URL of the inviter logo for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "type": "string" }, "logo_shape": { "description": "Logo shape for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "enum": [ "circle", "square" ], "type": "string" }, "primary_button_color": { "description": "Primary button color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "type": "string" }, "primary_button_text_color": { "description": "Primary button text color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "type": "string" }, "success_message": { "description": "Success message for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "type": "string" } }, "type": "object" }, "is_publishable_key_auth_enabled": { "description": "Indicates whether publishable key authentication is enabled for this workspace.", "type": "boolean" }, "is_sandbox": { "description": "Indicates whether the workspace is a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces).", "type": "boolean" }, "is_suspended": { "description": "Indicates whether the [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.", "type": "boolean" }, "name": { "description": "Name of the [workspace](/core-concepts/workspaces).", "type": "string" }, "organization_id": { "description": "ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.", "format": "uuid", "nullable": true, "type": "string" }, "publishable_key": { "description": "Publishable key for the [workspace](/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.", "type": "string" }, "workspace_id": { "description": "ID of the workspace.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "name", "company_name", "is_sandbox", "connect_webview_customization", "is_suspended", "connect_partner_name", "is_publishable_key_auth_enabled", "organization_id" ], "type": "object", "x-route-path": "/workspaces" } }, "securitySchemes": { "api_key": { "bearerFormat": "API Key", "scheme": "bearer", "type": "http" }, "bridge_client_session": { "bearerFormat": "Bridge Client Session Token", "scheme": "bearer", "type": "http" }, "certified_client": { "bearerFormat": "Certified Client", "scheme": "bearer", "type": "http" }, "client_session": { "bearerFormat": "Client Session Token", "scheme": "bearer", "type": "http" }, "client_session_token": { "in": "header", "name": "client-session-token", "type": "apiKey" }, "client_session_with_customer": { "bearerFormat": "Customer Client Session Token", "scheme": "bearer", "type": "http" }, "console_session_with_workspace": { "bearerFormat": "Console Session Token", "scheme": "bearer", "type": "http" }, "console_session_without_workspace": { "bearerFormat": "Console Session Token", "scheme": "bearer", "type": "http" }, "pat_with_workspace": { "bearerFormat": "API Token", "scheme": "bearer", "type": "http" }, "pat_without_workspace": { "bearerFormat": "API Token", "scheme": "bearer", "type": "http" }, "publishable_key": { "in": "header", "name": "seam-publishable-key", "type": "apiKey" }, "seam_client_session_token": { "in": "header", "name": "seam-client-session-token", "type": "apiKey" }, "seam_workspace": { "in": "header", "name": "seam-workspace", "type": "apiKey" } } }, "tags": [ { "description": "access_codes", "name": "/access_codes" }, { "description": "acs", "name": "/acs" }, { "description": "action_attempts", "name": "/action_attempts" }, { "description": "client_sessions", "name": "/client_sessions" }, { "description": "connected_accounts", "name": "/connected_accounts" }, { "description": "connect_webviews", "name": "/connect_webviews" }, { "description": "devices", "name": "/devices" }, { "description": "events", "name": "/events" }, { "description": "health", "name": "/health" }, { "description": "locks", "name": "/locks" }, { "description": "networks", "name": "/networks" }, { "description": "noise_sensors", "name": "/noise_sensors" }, { "description": "phones", "name": "/phones" }, { "description": "thermostats", "name": "/thermostats" }, { "description": "user_identities", "name": "/user_identities" }, { "description": "webhooks", "name": "/webhooks" }, { "description": "workspaces", "name": "/workspaces" } ], "paths": { "/access_codes/create": { "post": { "description": "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 only when you need direct control over a code on a single device, such as setting a custom PIN value.", "operationId": "accessCodesCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "common_code_key": { "description": "Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).", "type": "string" }, "device_id": { "description": "ID of the device for which you want to create the new access code.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "is_offline_access_code": { "description": "Indicates whether the access code is an [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.", "type": "boolean" }, "max_time_rounding": { "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.", "enum": [ "1hour", "1day", "1h", "1d" ], "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" }, "use_offline_access_code": { "deprecated": true, "type": "boolean", "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/access_code" } }, "required": [ "access_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create an Access Code", "tags": [ "/access_codes" ], "x-action-attempt-type": "CREATE_ACCESS_CODE", "x-response-key": "access_code", "x-title": "Create an Access Code", "x-mint": { "href": "/api/access_codes/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.create({\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n});\n\n/*\n{\n \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\": \"1234\",\n \"common_code_key\": null,\n \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n \"device_id\": \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"errors\": [],\n \"is_backup\": false,\n \"is_backup_access_code_available\": false,\n \"is_external_modification_allowed\": false,\n \"is_managed\": true,\n \"is_offline_access_code\": false,\n \"is_one_time_use\": false,\n \"is_scheduled_on_device\": true,\n \"is_waiting_for_code_assignment\": false,\n \"name\": \"My Ongoing Online Access Code\",\n \"pulled_backup_access_code_id\": null,\n \"status\": \"set\",\n \"type\": \"ongoing\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Ongoing Online Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"status\" => \"set\",\n \"type\" => \"ongoing\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->create(\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n);\n\n// [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Ongoing Online Access Code\",\n \"pulled_backup_access_code_id\" => null,\n \"status\" => \"set\",\n \"type\" => \"ongoing\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes create --device_id \"a5036385-adcb-41b5-88c2-dd8a702a0730\" --name \"My Ongoing Online Access Code\" --code \"1234\"\n\n# {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Ongoing Online Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"status\": \"set\",\n# \"type\": \"ongoing\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_codes/create_multiple": { "post": { "description": "Creates new [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).\n\nFor granting a person access to a space, [Access Grants](/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.", "operationId": "accessCodesCreateMultiplePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "behavior_when_code_cannot_be_shared": { "default": "throw", "description": "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.", "enum": [ "throw", "create_random_code" ], "type": "string" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_ids": { "description": "IDs of the devices for which you want to create the new access codes.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" } }, "required": [ "device_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/access_code" }, "type": "array" } }, "required": [ "access_codes" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create Multiple Linked Access Codes", "tags": [ "/access_codes" ], "x-response-key": "access_codes", "x-title": "Create Multiple Linked Access Codes", "x-mint": { "href": "/api/access_codes/create_multiple" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.createMultiple({\n device_ids: [\n \"d9717800-fa73-401a-b66b-03f0ef950e2a\",\n \"550e8400-e29b-41d4-a716-446655440000\",\n ],\n behavior_when_code_cannot_be_shared: \"throw\",\n preferred_code_length: 4,\n name: \"My Linked Access Code\",\n starts_at: \"2025-06-19T01:41:56.000Z\",\n ends_at: \"2025-06-22T16:40:40.000Z\",\n});\n\n/*\n[\n {\n \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\": \"1234\",\n \"common_code_key\": \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n \"errors\": [],\n \"is_backup\": false,\n \"is_backup_access_code_available\": false,\n \"is_external_modification_allowed\": false,\n \"is_managed\": true,\n \"is_offline_access_code\": false,\n \"is_one_time_use\": false,\n \"is_scheduled_on_device\": true,\n \"is_waiting_for_code_assignment\": false,\n \"name\": \"My Linked Access Code\",\n \"pulled_backup_access_code_id\": null,\n \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Linked Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->create_multiple(\n device_ids: [\n \"d9717800-fa73-401a-b66b-03f0ef950e2a\",\n \"550e8400-e29b-41d4-a716-446655440000\",\n ],\n behavior_when_code_cannot_be_shared: \"throw\",\n preferred_code_length: 4,\n name: \"My Linked Access Code\",\n starts_at: \"2025-06-19T01:41:56.000Z\",\n ends_at: \"2025-06-22T16:40:40.000Z\",\n);\n\n// [\n [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" =>\n \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Linked Access Code\",\n \"pulled_backup_access_code_id\" => null,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes create-multiple --device_ids [\"d9717800-fa73-401a-b66b-03f0ef950e2a\",\"550e8400-e29b-41d4-a716-446655440000\"] --behavior_when_code_cannot_be_shared \"throw\" --preferred_code_length 4 --name \"My Linked Access Code\" --starts_at \"2025-06-19T01:41:56.000Z\" --ends_at \"2025-06-22T16:40:40.000Z\"\n\n# [\n# {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Linked Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]" } ] }, "put": { "description": "Creates new [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).\n\nFor granting a person access to a space, [Access Grants](/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.", "operationId": "accessCodesCreateMultiplePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "behavior_when_code_cannot_be_shared": { "default": "throw", "description": "Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.", "enum": [ "throw", "create_random_code" ], "type": "string" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_ids": { "description": "IDs of the devices for which you want to create the new access codes.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" } }, "required": [ "device_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/access_code" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "access_codes", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/create_multiple", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "create_multiple", "x-fern-sdk-return-value": "access_codes", "x-response-key": "access_codes", "x-title": "Create Multiple Linked Access Codes" } }, "/access_codes/delete": { "delete": { "description": "Deletes an [access code](/low-level-apis/smart-locks/access-codes).", "operationId": "accessCodesDeleteDelete", "parameters": [ { "in": "query", "name": "device_id", "required": false, "schema": { "description": "ID of the device for which you want to delete the access code.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_id", "required": true, "schema": { "description": "ID of the access code that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/delete", "tags": [ "/access_codes" ], "x-action-attempt-type": "DELETE_ACCESS_CODE", "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Access Code" }, "post": { "description": "Deletes an [access code](/low-level-apis/smart-locks/access-codes).", "operationId": "accessCodesDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code that you want to delete.", "format": "uuid", "type": "string" }, "device_id": { "description": "ID of the device for which you want to delete the access code.", "format": "uuid", "type": "string" } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete an Access Code", "tags": [ "/access_codes" ], "x-action-attempt-type": "DELETE_ACCESS_CODE", "x-response-key": null, "x-title": "Delete an Access Code", "x-mint": { "href": "/api/access_codes/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.delete({\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->delete(\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes delete --device_id \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\" --access_code_id \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\"\n\n# {}" } ] } }, "/access_codes/generate_code": { "get": { "description": "Generates a code for an [access code](/low-level-apis/smart-locks/access-codes), given a device ID.", "operationId": "accessCodesGenerateCodeGet", "parameters": [ { "in": "query", "name": "device_id", "required": true, "schema": { "description": "ID of the device for which you want to generate a code.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "generated_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": [ "generated_code", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/generate_code", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "generate_code", "x-fern-sdk-return-value": "generated_code", "x-response-key": "generated_code", "x-title": "Generate a Code" }, "post": { "description": "Generates a code for an [access code](/low-level-apis/smart-locks/access-codes), given a device ID.", "operationId": "accessCodesGenerateCodePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to generate a code.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "generated_code": { "$ref": "#/components/schemas/access_code" } }, "required": [ "generated_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Generate a Code", "tags": [ "/access_codes" ], "x-response-key": "generated_code", "x-title": "Generate a Code", "x-mint": { "href": "/api/access_codes/generate_code" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < { \"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\" }" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes generate-code --device_id \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n\n# {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }" } ] } }, "/access_codes/get": { "get": { "description": "Returns a specified [access code](/low-level-apis/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesGetGet", "parameters": [ { "in": "query", "name": "device_id", "schema": { "description": "ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_id", "schema": { "description": "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "code", "schema": { "description": "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/access_code" }, "ok": { "type": "boolean" } }, "required": [ "access_code", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "summary": "/access_codes/get", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code", "x-response-key": "access_code", "x-title": "Get an Access Code" }, "post": { "description": "Returns a specified [access code](/low-level-apis/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" }, "code": { "description": "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "type": "string" }, "device_id": { "description": "ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/access_code" } }, "required": [ "access_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "summary": "Get an Access Code", "tags": [ "/access_codes" ], "x-response-key": "access_code", "x-title": "Get an Access Code", "x-mint": { "href": "/api/access_codes/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.get({\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n});\n\n/*\n{\n \"access_code_id\": \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n \"code\": \"1234\",\n \"common_code_key\": null,\n \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n \"device_id\": \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n \"errors\": [],\n \"is_backup\": false,\n \"is_backup_access_code_available\": false,\n \"is_external_modification_allowed\": false,\n \"is_managed\": true,\n \"is_offline_access_code\": false,\n \"is_one_time_use\": false,\n \"is_scheduled_on_device\": true,\n \"is_waiting_for_code_assignment\": false,\n \"name\": \"My Access Code\",\n \"pulled_backup_access_code_id\": null,\n \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->get(\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n);\n\n// [\n \"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n \"code\" => \"1234\",\n \"common_code_key\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => null,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes get --access_code_id \"90a114dc-48b5-4b8b-a3d3-972344594401\"\n\n# {\n# \"access_code_id\": \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_codes/list": { "get": { "description": "Returns a list of all [access codes](/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "operationId": "accessCodesListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list access codes.", "type": "string" } }, { "in": "query", "name": "device_id", "schema": { "description": "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_ids", "schema": { "description": "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "access_method_id", "schema": { "description": "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_id", "schema": { "description": "ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_key", "schema": { "description": "Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your user ID for the user by which to filter access codes.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 55000, "description": "Numerical limit on the number of access codes to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/access_code" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_codes", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/list", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes", "x-response-key": "access_codes", "x-title": "List Access Codes" }, "post": { "description": "Returns a list of all [access codes](/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "operationId": "accessCodesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_ids": { "description": "IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_id": { "description": "ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "type": "string" }, "access_method_id": { "description": "ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" }, "customer_key": { "description": "Customer key for which you want to list access codes.", "type": "string" }, "device_id": { "description": "ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.", "format": "uuid", "type": "string" }, "limit": { "default": 55000, "description": "Numerical limit on the number of access codes to return.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.", "minLength": 1, "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user by which to filter access codes.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/access_code" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_codes", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Access Codes", "tags": [ "/access_codes" ], "x-response-key": "access_codes", "x-title": "List Access Codes", "x-mint": { "href": "/api/access_codes/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.list({\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n});\n\n/*\n[\n {\n \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\": \"1234\",\n \"common_code_key\": null,\n \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n \"device_id\": \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n \"errors\": [],\n \"is_backup\": false,\n \"is_backup_access_code_available\": false,\n \"is_external_modification_allowed\": false,\n \"is_managed\": true,\n \"is_offline_access_code\": false,\n \"is_one_time_use\": false,\n \"is_scheduled_on_device\": true,\n \"is_waiting_for_code_assignment\": false,\n \"name\": \"My Access Code\",\n \"pulled_backup_access_code_id\": null,\n \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->list(\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n);\n\n// [\n [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => null,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes list --device_id \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\" --limit 10\n\n# [\n# {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]" } ] } }, "/access_codes/pull_backup_access_code": { "post": { "description": "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).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", "operationId": "accessCodesPullBackupAccessCodePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code for which you want to pull a backup access code.", "format": "uuid", "type": "string" } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/access_code" } }, "required": [ "access_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Pull a Backup Access Code", "tags": [ "/access_codes" ], "x-response-key": "access_code", "x-title": "Pull a Backup Access Code", "x-mint": { "href": "/api/access_codes/pull_backup_access_code" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.pullBackupAccessCode({\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n});\n\n/*\n{\n \"access_code_id\": \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n \"code\": \"1234\",\n \"common_code_key\": null,\n \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n \"errors\": [],\n \"is_backup\": false,\n \"is_backup_access_code_available\": true,\n \"is_external_modification_allowed\": false,\n \"is_managed\": true,\n \"is_offline_access_code\": false,\n \"is_one_time_use\": false,\n \"is_scheduled_on_device\": true,\n \"is_waiting_for_code_assignment\": false,\n \"name\": \"My Access Code\",\n \"pulled_backup_access_code_id\": \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n \"status\": \"unset\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/pull_backup_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => true,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"unset\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->pull_backup_access_code(\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n);\n\n// [\n \"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n \"code\" => \"1234\",\n \"common_code_key\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => true,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"unset\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes pull-backup-access-code --access_code_id \"8e525b87-5e4b-48a5-a322-5d45262a735f\"\n\n# {\n# \"access_code_id\": \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": true,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"unset\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_codes/report_device_constraints": { "post": { "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.", "operationId": "accessCodesReportDeviceConstraintsPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to report constraints.", "format": "uuid", "type": "string" }, "max_code_length": { "description": "Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.", "maximum": 20, "minimum": 4, "type": "integer" }, "min_code_length": { "description": "Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.", "maximum": 20, "minimum": 4, "type": "integer" }, "supported_code_lengths": { "description": "Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.", "items": { "maximum": 20, "minimum": 4, "type": "integer" }, "minItems": 1, "type": "array" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Report Device Access Code Constraints", "tags": [ "/access_codes" ], "x-response-key": null, "x-title": "Report Device Access Code Constraints", "x-mint": { "href": "/api/access_codes/report_device_constraints" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.reportDeviceConstraints({\n device_id: \"cd17e797-e952-47a1-ba47-46bf72934181\",\n supported_code_lengths: [4, 5, 6],\n min_code_length: 42,\n max_code_length: 42,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/report_device_constraints\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->report_device_constraints(\n device_id: \"cd17e797-e952-47a1-ba47-46bf72934181\",\n supported_code_lengths: [4, 5, 6],\n min_code_length: 42,\n max_code_length: 42,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes report-device-constraints --device_id \"cd17e797-e952-47a1-ba47-46bf72934181\" --supported_code_lengths [4,5,6] --min_code_length 42 --max_code_length 42\n\n# {}" } ] } }, "/access_codes/simulate/create_unmanaged_access_code": { "post": { "description": "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).", "operationId": "accessCodesSimulateCreateUnmanagedAccessCodePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "Code of the simulated unmanaged access code.", "maxLength": 8, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_id": { "description": "ID of the device for which you want to simulate the creation of an unmanaged access code.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the simulated unmanaged access code.", "type": "string" } }, "required": [ "device_id", "name", "code" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "required": [ "access_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Simulate Creating an Unmanaged Access Code", "tags": [ "/access_codes" ], "x-response-key": "access_code", "x-title": "Simulate Creating an Unmanaged Access Code", "x-mint": { "href": "/api/access_codes/simulate/create_unmanaged_access_code" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n});\n\n/*\n{\n \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\": \"1234\",\n \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n \"device_id\": \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n \"errors\": [],\n \"is_managed\": false,\n \"name\": \"My Access Code\",\n \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/simulate/create_unmanaged_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->simulate->create_unmanaged_access_code(\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n);\n\n// [\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes simulate create-unmanaged-access-code --device_id \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\" --name \"My Access Code\" --code \"1234\"\n\n# {\n# \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n# \"device_id\": \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n# \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"name\": \"My Access Code\",\n# \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_codes/unmanaged/convert_to_managed": { "patch": { "description": "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).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.", "operationId": "accessCodesUnmanagedConvertToManagedPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to convert to a managed access code.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.", "type": "boolean" }, "force": { "description": "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.", "type": "boolean" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.", "type": "boolean" } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/unmanaged/convert_to_managed", "tags": [ "/access_codes" ], "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED", "x-fern-sdk-group-name": [ "access_codes", "unmanaged" ], "x-fern-sdk-method-name": "convert_to_managed", "x-response-key": null, "x-title": "Convert an Unmanaged Access Code" }, "post": { "description": "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).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.", "operationId": "accessCodesUnmanagedConvertToManagedPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to convert to a managed access code.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.", "type": "boolean" }, "force": { "description": "Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.", "type": "boolean" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.", "type": "boolean" } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Convert an Unmanaged Access Code", "tags": [ "/access_codes" ], "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED", "x-response-key": null, "x-title": "Convert an Unmanaged Access Code", "x-mint": { "href": "/api/access_codes/unmanaged/convert_to_managed" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.unmanaged.convertToManaged({\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/convert_to_managed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->unmanaged->convert_to_managed(\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes unmanaged convert-to-managed --access_code_id \"9ef2af02-e335-4b49-bd51-00e851a83ef6\" --is_external_modification_allowed true --force true\n\n# {}" } ] } }, "/access_codes/unmanaged/delete": { "delete": { "description": "Deletes an [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedDeleteDelete", "parameters": [ { "in": "query", "name": "access_code_id", "required": true, "schema": { "description": "ID of the unmanaged access code that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/unmanaged/delete", "tags": [ "/access_codes" ], "x-action-attempt-type": "DELETE_ACCESS_CODE", "x-fern-sdk-group-name": [ "access_codes", "unmanaged" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Unmanaged Access Code" }, "post": { "description": "Deletes an [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete an Unmanaged Access Code", "tags": [ "/access_codes" ], "x-action-attempt-type": "DELETE_ACCESS_CODE", "x-response-key": null, "x-title": "Delete an Unmanaged Access Code", "x-mint": { "href": "/api/access_codes/unmanaged/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.unmanaged.delete({\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->unmanaged->delete(\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes unmanaged delete --access_code_id \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\"\n\n# {}" } ] } }, "/access_codes/unmanaged/get": { "get": { "description": "Returns a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesUnmanagedGetGet", "parameters": [ { "in": "query", "name": "device_id", "schema": { "description": "ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_id", "schema": { "description": "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "code", "schema": { "description": "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" }, "ok": { "type": "boolean" } }, "required": [ "access_code", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/unmanaged/get", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes", "unmanaged" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_code", "x-response-key": "access_code", "x-title": "Get an Unmanaged Access Code" }, "post": { "description": "Returns a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.", "operationId": "accessCodesUnmanagedGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" }, "code": { "description": "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "type": "string" }, "device_id": { "description": "ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_code": { "$ref": "#/components/schemas/unmanaged_access_code" } }, "required": [ "access_code" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Unmanaged Access Code", "tags": [ "/access_codes" ], "x-response-key": "access_code", "x-title": "Get an Unmanaged Access Code", "x-mint": { "href": "/api/access_codes/unmanaged/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.unmanaged.get({\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n});\n\n/*\n{\n \"access_code_id\": \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n \"code\": \"1234\",\n \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n \"device_id\": \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n \"errors\": [],\n \"is_managed\": false,\n \"name\": \"My Unmanaged Access Code\",\n \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->unmanaged->get(\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n);\n\n// [\n \"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes unmanaged get --access_code_id \"41b984ec-1b74-48cd-ba68-16660cd792b6\"\n\n# {\n# \"access_code_id\": \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n# \"device_id\": \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n# \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"name\": \"My Unmanaged Access Code\",\n# \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_codes/unmanaged/list": { "get": { "description": "Returns a list of all [unmanaged access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedListGet", "parameters": [ { "in": "query", "name": "device_id", "required": true, "schema": { "description": "ID of the device for which you want to list unmanaged access codes.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "required": false, "schema": { "description": "Your user ID for the user by which to filter unmanaged access codes.", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 300000, "description": "Numerical limit on the number of unmanaged access codes to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "search", "required": false, "schema": { "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "page_cursor", "required": false, "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/unmanaged_access_code" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_codes", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/unmanaged/list", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes", "unmanaged" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_codes", "x-response-key": "access_codes", "x-title": "List Unmanaged Access Codes" }, "post": { "description": "Returns a list of all [unmanaged access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to list unmanaged access codes.", "format": "uuid", "type": "string" }, "limit": { "default": 300000, "description": "Numerical limit on the number of unmanaged access codes to return.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.", "minLength": 1, "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user by which to filter unmanaged access codes.", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_codes": { "items": { "$ref": "#/components/schemas/unmanaged_access_code" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_codes", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Unmanaged Access Codes", "tags": [ "/access_codes" ], "x-response-key": "access_codes", "x-title": "List Unmanaged Access Codes", "x-mint": { "href": "/api/access_codes/unmanaged/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.unmanaged.list({\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n});\n\n/*\n[\n {\n \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\": \"1234\",\n \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n \"device_id\": \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n \"errors\": [],\n \"is_managed\": false,\n \"name\": \"My Unmanaged Access Code\",\n \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n \"status\": \"set\",\n \"type\": \"time_bound\",\n \"warnings\": [],\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->unmanaged->list(\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n);\n\n// [\n [\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes unmanaged list --device_id \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\"\n\n# [\n# {\n# \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n# \"device_id\": \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n# \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"name\": \"My Unmanaged Access Code\",\n# \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]" } ] } }, "/access_codes/unmanaged/update": { "patch": { "description": "Updates a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to update.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.", "type": "boolean" }, "force": { "description": "Indicates whether to force the unmanaged access code update.", "type": "boolean" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.", "type": "boolean" }, "is_managed": { "type": "boolean" } }, "required": [ "access_code_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/unmanaged/update", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes", "unmanaged" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Unmanaged Access Code" }, "post": { "description": "Updates a specified [unmanaged access code](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).", "operationId": "accessCodesUnmanagedUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the unmanaged access code that you want to update.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.", "type": "boolean" }, "force": { "description": "Indicates whether to force the unmanaged access code update.", "type": "boolean" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.", "type": "boolean" }, "is_managed": { "type": "boolean" } }, "required": [ "access_code_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update an Unmanaged Access Code", "tags": [ "/access_codes" ], "x-response-key": null, "x-title": "Update an Unmanaged Access Code", "x-mint": { "href": "/api/access_codes/unmanaged/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.unmanaged.update({\n access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\n is_managed: true,\n is_external_modification_allowed: true,\n force: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->unmanaged->update(\n access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\n is_managed: true,\n is_external_modification_allowed: true,\n force: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes unmanaged update --access_code_id \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\" --is_managed true --is_external_modification_allowed true --force true\n\n# {}" } ] } }, "/access_codes/update": { "patch": { "description": "Updates a specified active or upcoming [access code](/low-level-apis/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](/low-level-apis/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code that you want to update.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_id": { "description": "ID of the device containing the access code that you want to update.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "is_managed": { "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.", "type": "boolean" }, "is_offline_access_code": { "description": "Indicates whether the access code is an [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.", "type": "boolean" }, "max_time_rounding": { "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.", "enum": [ "1hour", "1day", "1h", "1d" ], "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "type": { "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).", "enum": [ "ongoing", "time_bound" ], "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" }, "use_offline_access_code": { "deprecated": true, "type": "boolean", "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/update", "tags": [ "/access_codes" ], "x-action-attempt-type": "UPDATE_ACCESS_CODE", "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Access Code" }, "post": { "description": "Updates a specified active or upcoming [access code](/low-level-apis/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](/low-level-apis/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code that you want to update.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_id": { "description": "ID of the device containing the access code that you want to update.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "is_managed": { "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.", "type": "boolean" }, "is_offline_access_code": { "description": "Indicates whether the access code is an [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.", "type": "boolean" }, "max_time_rounding": { "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.", "enum": [ "1hour", "1day", "1h", "1d" ], "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "type": { "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).", "enum": [ "ongoing", "time_bound" ], "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" }, "use_offline_access_code": { "deprecated": true, "type": "boolean", "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update an Access Code", "tags": [ "/access_codes" ], "x-action-attempt-type": "UPDATE_ACCESS_CODE", "x-response-key": null, "x-title": "Update an Access Code", "x-mint": { "href": "/api/access_codes/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.update({\n access_code_id: \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\",\n name: \"My Updated Access Code\",\n starts_at: \"2025-06-19T08:26:41.000Z\",\n ends_at: \"2025-06-21T17:38:07.000Z\",\n code: \"4444\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->update(\n access_code_id: \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\",\n name: \"My Updated Access Code\",\n starts_at: \"2025-06-19T08:26:41.000Z\",\n ends_at: \"2025-06-21T17:38:07.000Z\",\n code: \"4444\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes update --access_code_id \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\" --name \"My Updated Access Code\" --starts_at \"2025-06-19T08:26:41.000Z\" --ends_at \"2025-06-21T17:38:07.000Z\" --code \"4444\"\n\n# {}" } ] }, "put": { "description": "Updates a specified active or upcoming [access code](/low-level-apis/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](/low-level-apis/smart-locks/access-codes/modifying-access-codes).", "operationId": "accessCodesUpdatePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code that you want to update.", "format": "uuid", "type": "string" }, "allow_external_modification": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "attempt_for_offline_device": { "default": true, "type": "boolean" }, "code": { "description": "Code to be used for access.", "maxLength": 12, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "device_id": { "description": "ID of the device containing the access code that you want to update.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "is_external_modification_allowed": { "description": "Indicates whether [external modification](/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "type": "boolean" }, "is_managed": { "description": "Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.", "type": "boolean" }, "is_offline_access_code": { "description": "Indicates whether the access code is an [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes).", "type": "boolean" }, "is_one_time_use": { "description": "Indicates whether the [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.", "type": "boolean" }, "max_time_rounding": { "description": "Maximum rounding adjustment. To create a daily-bound [offline access code](/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.", "enum": [ "1hour", "1day", "1h", "1d" ], "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "prefer_native_scheduling": { "description": "Indicates whether [native scheduling](/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.", "type": "boolean" }, "preferred_code_length": { "description": "Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.", "format": "float", "type": "number" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "type": { "description": "Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).", "enum": [ "ongoing", "time_bound" ], "type": "string" }, "use_backup_access_code_pool": { "description": "Indicates whether to use a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](/api/access_codes/pull_backup_access_code).", "type": "boolean" }, "use_offline_access_code": { "deprecated": true, "type": "boolean", "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ "access_code_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/update", "tags": [ "/access_codes" ], "x-action-attempt-type": "UPDATE_ACCESS_CODE", "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Access Code" } }, "/access_codes/update_multiple": { "patch": { "description": "Updates [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).", "operationId": "accessCodesUpdateMultiplePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "common_code_key": { "description": "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" } }, "required": [ "common_code_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_codes/update_multiple", "tags": [ "/access_codes" ], "x-fern-sdk-group-name": [ "access_codes" ], "x-fern-sdk-method-name": "update_multiple", "x-response-key": null, "x-title": "Update Multiple Linked Access Codes" }, "post": { "description": "Updates [access codes](/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).", "operationId": "accessCodesUpdateMultiplePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "common_code_key": { "description": "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "type": "string" }, "name": { "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" } }, "required": [ "common_code_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update Multiple Linked Access Codes", "tags": [ "/access_codes" ], "x-response-key": null, "x-title": "Update Multiple Linked Access Codes", "x-mint": { "href": "/api/access_codes/update_multiple" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessCodes.updateMultiple({\n ends_at: \"2025-06-22T05:05:47.000Z\",\n starts_at: \"2025-06-18T19:14:13.000Z\",\n name: \"My Updated Linked Access Code\",\n common_code_key:\n \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_codes->update_multiple(\n ends_at: \"2025-06-22T05:05:47.000Z\",\n starts_at: \"2025-06-18T19:14:13.000Z\",\n name: \"My Updated Linked Access Code\",\n common_code_key: \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-codes update-multiple --ends_at \"2025-06-22T05:05:47.000Z\" --starts_at \"2025-06-18T19:14:13.000Z\" --name \"My Updated Linked Access Code\" --common_code_key \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\"\n\n# {}" } ] } }, "/access_grants/create": { "post": { "description": "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_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.", "operationId": "accessGrantsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "properties": { "user_identity_id": { "description": "ID of user identity for whom access is being granted.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" }, { "properties": { "user_identity": { "description": "When used, creates a new user identity with the given details, and grants them access.", "properties": { "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity.", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "user_identity" ], "type": "object" } ] }, { "properties": { "access_grant_key": { "description": "Unique key for the access grant within the workspace.", "minLength": 1, "type": "string" }, "acs_entrance_ids": { "default": [], "description": "Set of IDs of the [entrances](/api/acs/systems/list) to which access is being granted.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "customization_profile_id": { "description": "ID of the customization profile to apply to the Access Grant and its access methods.", "format": "uuid", "type": "string" }, "device_ids": { "default": [], "description": "Set of IDs of the [devices](/api/devices/list) to which access is being granted.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "ends_at": { "default": null, "description": "Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "nullable": true, "type": "string" }, "location": { "deprecated": true, "properties": { "acs_entrance_ids": { "default": [], "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `acs_entrance_ids` at the top level." }, "device_ids": { "default": [], "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `device_ids` at the top level." }, "name": { "description": "Name of the location.", "type": "string" } }, "type": "object", "description": "Deprecated. Create a space first, then reference it using `space_ids`." }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name for the access grant.", "nullable": true, "type": "string" }, "requested_access_methods": { "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "mode" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "Set of IDs of existing spaces to which access is being granted.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "space_keys": { "description": "Set of keys of existing spaces to which access is being granted.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" } }, "required": [ "requested_access_methods" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" } }, "required": [ "access_grant" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Create an Access Grant", "tags": [], "x-response-key": "access_grant", "x-title": "Create an Access Grant", "x-mint": { "href": "/api/access_grants/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessGrants.create({\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [{ mode: \"code\" }],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n});\n\n/*\n{\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_grants->create(\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [[\"mode\" => \"code\"]],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n);\n\n// [\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n [\n \"display_name\" => \"PIN Code Credential\",\n \"mode\" => \"code\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n ],\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-grants create --user_identity_id \"e3d736c1-540d-4d10-83e5-9a4e135453b4\" --device_ids [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"] --requested_access_methods [{\"mode\":\"code\"}] --starts_at \"2025-06-16T16:54:17.946606Z\" --ends_at \"2025-06-18T16:54:17.946606Z\"\n\n# {\n# \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n# \"access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"My Access Grant\",\n# \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n# \"requested_access_methods\": [\n# {\n# \"display_name\": \"PIN Code Credential\",\n# \"mode\": \"code\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"created_access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ]\n# }\n# ],\n# \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_grants/delete": { "delete": { "description": "Delete an Access Grant.", "operationId": "accessGrantsDeleteDelete", "parameters": [ { "in": "query", "name": "access_grant_id", "required": true, "schema": { "description": "ID of Access Grant to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/delete", "tags": [], "x-fern-sdk-group-name": [ "access_grants" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Access Grant" }, "post": { "description": "Delete an Access Grant.", "operationId": "accessGrantsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of Access Grant to delete.", "format": "uuid", "type": "string" } }, "required": [ "access_grant_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Delete an Access Grant", "tags": [], "x-response-key": null, "x-title": "Delete an Access Grant", "x-mint": { "href": "/api/access_grants/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessGrants.delete({\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_grants->delete(\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-grants delete --access_grant_id \"403ea27b-af76-4a48-ace9-8f9498f4c25c\"\n\n# {}" } ] } }, "/access_grants/get": { "get": { "description": "Get an Access Grant.", "operationId": "accessGrantsGetGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" }, "ok": { "type": "boolean" } }, "required": [ "access_grant", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/get", "tags": [], "x-fern-sdk-group-name": [ "access_grants" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant", "x-response-key": "access_grant", "x-title": "Get an Access Grant" }, "post": { "description": "Get an Access Grant.", "operationId": "accessGrantsGetPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "access_grant_id": { "description": "ID of Access Grant to get.", "format": "uuid", "type": "string" } }, "required": [ "access_grant_id" ], "type": "object" }, { "properties": { "access_grant_key": { "description": "Unique key of Access Grant to get.", "type": "string" } }, "required": [ "access_grant_key" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" } }, "required": [ "access_grant" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get an Access Grant", "tags": [], "x-response-key": "access_grant", "x-title": "Get an Access Grant", "x-mint": { "href": "/api/access_grants/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessGrants.get({\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n});\n\n/*\n{\n \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n ],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ]\n },\n {\n \"display_name\": \"Card Credential\",\n \"mode\": \"card\",\n \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n \"created_access_method_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n ]\n },\n {\n \"display_name\": \"Mobile Key Credential\",\n \"mode\": \"mobile_key\",\n \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n \"created_access_method_ids\": [\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n ]\n }\n ],\n \"space_ids\": [\n \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\" => %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n \"space_ids\" => %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_grants->get(\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n);\n\n// [\n \"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n ],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\" => [\n [\n \"display_name\" => \"PIN Code Credential\",\n \"mode\" => \"code\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n ],\n [\n \"display_name\" => \"Card Credential\",\n \"mode\" => \"card\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"created_access_method_ids\" => [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n ],\n ],\n [\n \"display_name\" => \"Mobile Key Credential\",\n \"mode\" => \"mobile_key\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"created_access_method_ids\" => [\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n ],\n ],\n ],\n \"space_ids\" => [\n \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-grants get --access_grant_id \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"\n\n# {\n# \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n# \"access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ],\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"My Access Grant\",\n# \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"requested_access_methods\": [\n# {\n# \"display_name\": \"PIN Code Credential\",\n# \"mode\": \"code\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"created_access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ]\n# },\n# {\n# \"display_name\": \"Card Credential\",\n# \"mode\": \"card\",\n# \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n# \"created_access_method_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ]\n# },\n# {\n# \"display_name\": \"Mobile Key Credential\",\n# \"mode\": \"mobile_key\",\n# \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n# \"created_access_method_ids\": [\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ]\n# }\n# ],\n# \"space_ids\": [\n# \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n# \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"\n# ],\n# \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }" } ] } }, "/access_grants/get_related": { "get": { "description": "Gets all related resources for one or more Access Grants.", "operationId": "accessGrantsGetRelatedGet", "parameters": [ { "in": "query", "name": "access_grant_ids", "schema": { "description": "IDs of the access grants that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "access_grant_keys", "schema": { "description": "Keys of the access grants that you want to get along with their related resources.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "include", "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "exclude", "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_access_groups": { "items": { "$ref": "#/components/schemas/acs_access_group" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" }, "user_identities": { "items": { "$ref": "#/components/schemas/user_identity" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": [ "batch", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_grants/get_related", "tags": [], "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "x-fern-sdk-group-name": [ "access_grants" ], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch", "x-response-key": "batch", "x-title": "Get related Access Grant resources" }, "post": { "description": "Gets all related resources for one or more Access Grants.", "operationId": "accessGrantsGetRelatedPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_ids": { "description": "IDs of the access grants that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_keys": { "description": "Keys of the access grants that you want to get along with their related resources.", "items": { "type": "string" }, "type": "array" }, "exclude": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "type": "string" }, "type": "array" }, "include": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "user_identities", "acs_access_groups", "access_methods" ], "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_access_groups": { "items": { "$ref": "#/components/schemas/acs_access_group" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" }, "user_identities": { "items": { "$ref": "#/components/schemas/user_identity" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" } }, "required": [ "batch" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get related Access Grant resources", "tags": [], "x-response-key": "batch", "x-title": "Get related Access Grant resources", "x-mint": { "href": "/api/access_grants/get_related" } } }, "/access_grants/list": { "get": { "description": "Gets an Access Grant.", "operationId": "accessGrantsListGet", "parameters": [ { "in": "query", "name": "access_grant_ids", "schema": { "description": "IDs of the access grants to retrieve.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list access grants.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of access grants to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of user identity by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_id", "schema": { "description": "ID of the entrance by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_id", "schema": { "description": "ID of the device by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "location_id", "schema": { "deprecated": true, "format": "uuid", "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_id", "schema": { "description": "ID of the access code by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_key", "schema": { "description": "Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.", "nullable": true, "type": "string" } }, { "in": "query", "name": "reservation_key", "schema": { "description": "Filter Access Grants by reservation_key.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grants": { "items": { "$ref": "#/components/schemas/access_grant" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_grants", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/list", "tags": [], "x-fern-sdk-group-name": [ "access_grants" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants", "x-response-key": "access_grants", "x-title": "List Access Grants" }, "post": { "description": "Gets an Access Grant.", "operationId": "accessGrantsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" }, "access_grant_ids": { "description": "IDs of the access grants to retrieve.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_key": { "description": "Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.", "nullable": true, "type": "string" }, "acs_entrance_id": { "description": "ID of the entrance by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" }, "customer_key": { "description": "Customer key for which you want to list access grants.", "type": "string" }, "device_id": { "description": "ID of the device by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" }, "limit": { "default": 500, "description": "Numerical limit on the number of access grants to return.", "format": "float", "type": "number" }, "location_id": { "deprecated": true, "format": "uuid", "type": "string", "description": "Deprecated. Use `space_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "reservation_key": { "description": "Filter Access Grants by reservation_key.", "type": "string" }, "space_id": { "description": "ID of the space by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of user identity by which you want to filter the list of Access Grants.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grants": { "items": { "$ref": "#/components/schemas/access_grant" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_grants", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Access Grants", "tags": [], "x-response-key": "access_grants", "x-title": "List Access Grants", "x-mint": { "href": "/api/access_grants/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessGrants.list({\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n acs_system_id: \"9f169742-048a-4105-84e3-bd1e0f9dc790\",\n acs_entrance_id: \"2673b363-4748-4a64-8075-f669c862ec74\",\n space_id: \"1d20c47d-3cc0-41ca-9917-bc798d071543\",\n});\n\n/*\n[\n {\n \"access_grant\": {\n \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n ],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ]\n },\n {\n \"display_name\": \"Card Credential\",\n \"mode\": \"card\",\n \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n \"created_access_method_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n ]\n },\n {\n \"display_name\": \"Mobile Key Credential\",\n \"mode\": \"mobile_key\",\n \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n \"created_access_method_ids\": [\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n ]\n }\n ],\n \"space_ids\": [\n \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n }\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_grant\" => {\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n access_method_ids: %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n created_at: \"2025-06-16T16:54:17.946606Z\",\n display_name: \"My Access Grant\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n instant_key_url: \"https://ik.seam.co/ABCXYZ\",\n requested_access_methods: [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n space_ids: %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n workspace_id: \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_grants->list(\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n acs_system_id: \"9f169742-048a-4105-84e3-bd1e0f9dc790\",\n acs_entrance_id: \"2673b363-4748-4a64-8075-f669c862ec74\",\n space_id: \"1d20c47d-3cc0-41ca-9917-bc798d071543\",\n);\n\n// [\n [\n \"access_grant\" => [\n \"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n ],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\" => [\n [\n \"display_name\" => \"PIN Code Credential\",\n \"mode\" => \"code\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n ],\n [\n \"display_name\" => \"Card Credential\",\n \"mode\" => \"card\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"created_access_method_ids\" => [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n ],\n ],\n [\n \"display_name\" => \"Mobile Key Credential\",\n \"mode\" => \"mobile_key\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"created_access_method_ids\" => [\n \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n ],\n ],\n ],\n \"space_ids\" => [\n \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-grants list --user_identity_id \"f7620fcf-d92f-471e-b97e-3806daeebd40\" --acs_system_id \"9f169742-048a-4105-84e3-bd1e0f9dc790\" --acs_entrance_id \"2673b363-4748-4a64-8075-f669c862ec74\" --space_id \"1d20c47d-3cc0-41ca-9917-bc798d071543\"\n\n# [\n# {\n# \"access_grant\": {\n# \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n# \"access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ],\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"My Access Grant\",\n# \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"requested_access_methods\": [\n# {\n# \"display_name\": \"PIN Code Credential\",\n# \"mode\": \"code\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"created_access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ]\n# },\n# {\n# \"display_name\": \"Card Credential\",\n# \"mode\": \"card\",\n# \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n# \"created_access_method_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ]\n# },\n# {\n# \"display_name\": \"Mobile Key Credential\",\n# \"mode\": \"mobile_key\",\n# \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n# \"created_access_method_ids\": [\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ]\n# }\n# ],\n# \"space_ids\": [\n# \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n# \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"\n# ],\n# \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"user_identity_id\": \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }\n# ]" } ] } }, "/access_grants/request_access_methods": { "post": { "description": "Adds additional requested access methods to an existing Access Grant.", "operationId": "accessGrantsRequestAccessMethodsPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of the Access Grant to add access methods to.", "format": "uuid", "type": "string" }, "requested_access_methods": { "description": "Array of requested access methods to add to the access grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "mode" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "access_grant_id", "requested_access_methods" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "$ref": "#/components/schemas/access_grant" } }, "required": [ "access_grant" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Add Requested Access Methods to Access Grant", "tags": [], "x-response-key": "access_grant", "x-title": "Add Requested Access Methods to Access Grant", "x-mint": { "href": "/api/access_grants/request_access_methods" } } }, "/access_grants/unmanaged/get": { "get": { "description": "Get an unmanaged Access Grant (where is_managed = false).", "operationId": "accessGrantsUnmanagedGetGet", "parameters": [ { "in": "query", "name": "access_grant_id", "required": true, "schema": { "description": "ID of unmanaged Access Grant to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_grant_id": { "description": "ID of the Access Grant.", "format": "uuid", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods created for the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the Access Grant was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the Access Grant.", "type": "string" }, "ends_at": { "description": "Date and time at which the Access Grant ends.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "description": "Errors associated with the [access grant](/use-cases/granting-access).", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam could not create one or more of the requested access methods for the access grant.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "cannot_create_requested_access_methods" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "access_grant" } ] }, "type": "array" }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", "nullable": true, "type": "string" }, "pending_mutations": { "description": "List of pending mutations for the access grant. This shows updates that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of updating the devices/spaces associated with this access grant.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous location configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access codes existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.", "enum": [ "updating_spaces" ], "type": "string" }, "to": { "description": "New location configuration.", "properties": { "common_code_key": { "description": "Common code key to ensure PIN code reuse across devices.", "nullable": true, "type": "string" }, "device_ids": { "description": "New device IDs where access codes should be created.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access grant.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "type": "object" } ] }, "type": "array" }, "requested_access_methods": { "description": "Access methods that the user requested for the Access Grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "created_access_method_ids": { "description": "IDs of the access methods created for the requested access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the requested access method was added to the Access Grant.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "IDs of the spaces to which the Access Grant gives access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the Access Grant starts.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of user identity to which the Access Grant gives access.", "format": "uuid", "type": "string" }, "warnings": { "description": "Warnings associated with the [access grant](/use-cases/granting-access).", "items": { "description": "Warning associated with the [access grant](/use-cases/granting-access).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access grant](/use-cases/granting-access) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "underprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "failed_devices": { "description": "Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).", "items": { "properties": { "device_id": { "description": "Device whose access code could not be revoked.", "format": "uuid", "type": "string" }, "error_code": { "description": "Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).", "type": "string" }, "message": { "description": "Human-readable description of why revocation failed.", "type": "string" } }, "required": [ "device_id", "error_code", "message" ], "type": "object" }, "type": "array" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "overprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access grant](/use-cases/granting-access) are being updated.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "type": "object" }, { "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device where the requested code was unavailable.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "new_code": { "description": "The new PIN code that was assigned instead.", "type": "string" }, "original_code": { "description": "The originally requested PIN code that was unavailable.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "requested_code_unavailable" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "type": "object" }, { "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device that does not support access codes.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_does_not_support_access_codes" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "type": "object" }, { "description": "Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device whose time constraints the access grant violates.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "reason": { "description": "Specific reason why the grant's times are not programmable on the device.", "enum": [ "duration_exceeds_max", "times_do_not_match_slots", "ongoing_not_supported" ], "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_time_constraints_violated" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "reason" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the Access Grant.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "type": "object", "x-route-path": "/access_grants/unmanaged" }, "ok": { "type": "boolean" } }, "required": [ "access_grant", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/unmanaged/get", "tags": [], "x-fern-sdk-group-name": [ "access_grants", "unmanaged" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_grant", "x-response-key": "access_grant", "x-title": "Get an Unmanaged Access Grant" }, "post": { "description": "Get an unmanaged Access Grant (where is_managed = false).", "operationId": "accessGrantsUnmanagedGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of unmanaged Access Grant to get.", "format": "uuid", "type": "string" } }, "required": [ "access_grant_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grant": { "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_grant_id": { "description": "ID of the Access Grant.", "format": "uuid", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods created for the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the Access Grant was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the Access Grant.", "type": "string" }, "ends_at": { "description": "Date and time at which the Access Grant ends.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "description": "Errors associated with the [access grant](/use-cases/granting-access).", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam could not create one or more of the requested access methods for the access grant.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "cannot_create_requested_access_methods" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "access_grant" } ] }, "type": "array" }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", "nullable": true, "type": "string" }, "pending_mutations": { "description": "List of pending mutations for the access grant. This shows updates that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of updating the devices/spaces associated with this access grant.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous location configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access codes existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.", "enum": [ "updating_spaces" ], "type": "string" }, "to": { "description": "New location configuration.", "properties": { "common_code_key": { "description": "Common code key to ensure PIN code reuse across devices.", "nullable": true, "type": "string" }, "device_ids": { "description": "New device IDs where access codes should be created.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access grant.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "type": "object" } ] }, "type": "array" }, "requested_access_methods": { "description": "Access methods that the user requested for the Access Grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "created_access_method_ids": { "description": "IDs of the access methods created for the requested access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the requested access method was added to the Access Grant.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "IDs of the spaces to which the Access Grant gives access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the Access Grant starts.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of user identity to which the Access Grant gives access.", "format": "uuid", "type": "string" }, "warnings": { "description": "Warnings associated with the [access grant](/use-cases/granting-access).", "items": { "description": "Warning associated with the [access grant](/use-cases/granting-access).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access grant](/use-cases/granting-access) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "underprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "failed_devices": { "description": "Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).", "items": { "properties": { "device_id": { "description": "Device whose access code could not be revoked.", "format": "uuid", "type": "string" }, "error_code": { "description": "Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).", "type": "string" }, "message": { "description": "Human-readable description of why revocation failed.", "type": "string" } }, "required": [ "device_id", "error_code", "message" ], "type": "object" }, "type": "array" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "overprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access grant](/use-cases/granting-access) are being updated.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "type": "object" }, { "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device where the requested code was unavailable.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "new_code": { "description": "The new PIN code that was assigned instead.", "type": "string" }, "original_code": { "description": "The originally requested PIN code that was unavailable.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "requested_code_unavailable" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "type": "object" }, { "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device that does not support access codes.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_does_not_support_access_codes" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "type": "object" }, { "description": "Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device whose time constraints the access grant violates.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "reason": { "description": "Specific reason why the grant's times are not programmable on the device.", "enum": [ "duration_exceeds_max", "times_do_not_match_slots", "ongoing_not_supported" ], "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_time_constraints_violated" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "reason" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the Access Grant.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "type": "object", "x-route-path": "/access_grants/unmanaged" } }, "required": [ "access_grant" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get an Unmanaged Access Grant", "tags": [], "x-response-key": "access_grant", "x-title": "Get an Unmanaged Access Grant", "x-mint": { "href": "/api/access_grants/unmanaged/get" } } }, "/access_grants/unmanaged/list": { "get": { "description": "Gets unmanaged Access Grants (where is_managed = false).", "operationId": "accessGrantsUnmanagedListGet", "parameters": [ { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of user identity by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_id", "schema": { "description": "ID of the entrance by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "reservation_key", "schema": { "description": "Filter unmanaged Access Grants by reservation_key.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of unmanaged access grants to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grants": { "items": { "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_grant_id": { "description": "ID of the Access Grant.", "format": "uuid", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods created for the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the Access Grant was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the Access Grant.", "type": "string" }, "ends_at": { "description": "Date and time at which the Access Grant ends.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "description": "Errors associated with the [access grant](/use-cases/granting-access).", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam could not create one or more of the requested access methods for the access grant.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "cannot_create_requested_access_methods" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "access_grant" } ] }, "type": "array" }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", "nullable": true, "type": "string" }, "pending_mutations": { "description": "List of pending mutations for the access grant. This shows updates that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of updating the devices/spaces associated with this access grant.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous location configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access codes existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.", "enum": [ "updating_spaces" ], "type": "string" }, "to": { "description": "New location configuration.", "properties": { "common_code_key": { "description": "Common code key to ensure PIN code reuse across devices.", "nullable": true, "type": "string" }, "device_ids": { "description": "New device IDs where access codes should be created.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access grant.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "type": "object" } ] }, "type": "array" }, "requested_access_methods": { "description": "Access methods that the user requested for the Access Grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "created_access_method_ids": { "description": "IDs of the access methods created for the requested access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the requested access method was added to the Access Grant.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "IDs of the spaces to which the Access Grant gives access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the Access Grant starts.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of user identity to which the Access Grant gives access.", "format": "uuid", "type": "string" }, "warnings": { "description": "Warnings associated with the [access grant](/use-cases/granting-access).", "items": { "description": "Warning associated with the [access grant](/use-cases/granting-access).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access grant](/use-cases/granting-access) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "underprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "failed_devices": { "description": "Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).", "items": { "properties": { "device_id": { "description": "Device whose access code could not be revoked.", "format": "uuid", "type": "string" }, "error_code": { "description": "Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).", "type": "string" }, "message": { "description": "Human-readable description of why revocation failed.", "type": "string" } }, "required": [ "device_id", "error_code", "message" ], "type": "object" }, "type": "array" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "overprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access grant](/use-cases/granting-access) are being updated.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "type": "object" }, { "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device where the requested code was unavailable.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "new_code": { "description": "The new PIN code that was assigned instead.", "type": "string" }, "original_code": { "description": "The originally requested PIN code that was unavailable.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "requested_code_unavailable" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "type": "object" }, { "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device that does not support access codes.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_does_not_support_access_codes" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "type": "object" }, { "description": "Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device whose time constraints the access grant violates.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "reason": { "description": "Specific reason why the grant's times are not programmable on the device.", "enum": [ "duration_exceeds_max", "times_do_not_match_slots", "ongoing_not_supported" ], "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_time_constraints_violated" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "reason" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the Access Grant.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "type": "object", "x-route-path": "/access_grants/unmanaged" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_grants", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/unmanaged/list", "tags": [], "x-fern-sdk-group-name": [ "access_grants", "unmanaged" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_grants", "x-response-key": "access_grants", "x-title": "List Unmanaged Access Grants" }, "post": { "description": "Gets unmanaged Access Grants (where is_managed = false).", "operationId": "accessGrantsUnmanagedListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_id": { "description": "ID of the entrance by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" }, "limit": { "default": 500, "description": "Numerical limit on the number of unmanaged access grants to return.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "reservation_key": { "description": "Filter unmanaged Access Grants by reservation_key.", "type": "string" }, "user_identity_id": { "description": "ID of user identity by which you want to filter the list of unmanaged Access Grants.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_grants": { "items": { "description": "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_grant_id": { "description": "ID of the Access Grant.", "format": "uuid", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods created for the Access Grant.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the Access Grant was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the Access Grant.", "type": "string" }, "ends_at": { "description": "Date and time at which the Access Grant ends.", "format": "date-time", "nullable": true, "type": "string" }, "errors": { "description": "Errors associated with the [access grant](/use-cases/granting-access).", "items": { "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that Seam could not create one or more of the requested access methods for the access grant.", "properties": { "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "cannot_create_requested_access_methods" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "missing_device_ids": { "description": "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "created_at", "message", "error_code" ], "type": "object", "x-resource-type": "access_grant" } ] }, "type": "array" }, "location_ids": { "deprecated": true, "items": { "format": "uuid", "type": "string" }, "type": "array", "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", "nullable": true, "type": "string" }, "pending_mutations": { "description": "List of pending mutations for the access grant. This shows updates that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of updating the devices/spaces associated with this access grant.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous location configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access codes existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.", "enum": [ "updating_spaces" ], "type": "string" }, "to": { "description": "New location configuration.", "properties": { "common_code_key": { "description": "Common code key to ensure PIN code reuse across devices.", "nullable": true, "type": "string" }, "device_ids": { "description": "New device IDs where access codes should be created.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access grant.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access grant.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "access_method_ids", "from", "to" ], "type": "object" } ] }, "type": "array" }, "requested_access_methods": { "description": "Access methods that the user requested for the Access Grant.", "items": { "properties": { "code": { "description": "Specific PIN code to use for this access method. Only applicable when mode is 'code'.", "maxLength": 9, "minLength": 4, "pattern": "^\\d+$", "type": "string" }, "created_access_method_ids": { "description": "IDs of the access methods created for the requested access method.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the requested access method was added to the Access Grant.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "instant_key_max_use_count": { "description": "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.", "minimum": 1, "type": "integer" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" } }, "required": [ "display_name", "mode", "created_at", "created_access_method_ids" ], "type": "object" }, "type": "array" }, "reservation_key": { "description": "Reservation key for the access grant.", "type": "string" }, "space_ids": { "description": "IDs of the spaces to which the Access Grant gives access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "starts_at": { "description": "Date and time at which the Access Grant starts.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of user identity to which the Access Grant gives access.", "format": "uuid", "type": "string" }, "warnings": { "description": "Warnings associated with the [access grant](/use-cases/granting-access).", "items": { "description": "Warning associated with the [access grant](/use-cases/granting-access).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access grant](/use-cases/granting-access) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "underprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "failed_devices": { "description": "Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).", "items": { "properties": { "device_id": { "description": "Device whose access code could not be revoked.", "format": "uuid", "type": "string" }, "error_code": { "description": "Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).", "type": "string" }, "message": { "description": "Human-readable description of why revocation failed.", "type": "string" } }, "required": [ "device_id", "error_code", "message" ], "type": "object" }, "type": "array" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "overprovisioned_access" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access grant](/use-cases/granting-access) are being updated.", "properties": { "access_method_ids": { "description": "IDs of the access methods being updated.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "access_method_ids" ], "type": "object" }, { "description": "Indicates that the requested PIN code was already in use on a device, so a different code was assigned.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device where the requested code was unavailable.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "new_code": { "description": "The new PIN code that was assigned instead.", "type": "string" }, "original_code": { "description": "The originally requested PIN code that was unavailable.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "requested_code_unavailable" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "original_code", "new_code" ], "type": "object" }, { "description": "Indicates that a device in the access grant does not support access codes and was excluded from code materialization.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device that does not support access codes.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_does_not_support_access_codes" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id" ], "type": "object" }, { "description": "Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "device_id": { "description": "ID of the device whose time constraints the access grant violates.", "format": "uuid", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "reason": { "description": "Specific reason why the grant's times are not programmable on the device.", "enum": [ "duration_exceeds_max", "times_do_not_match_slots", "ongoing_not_supported" ], "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "device_time_constraints_violated" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code", "device_id", "reason" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the Access Grant.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_grant_id", "location_ids", "space_ids", "requested_access_methods", "access_method_ids", "name", "display_name", "created_at", "starts_at", "ends_at", "warnings", "errors", "pending_mutations" ], "type": "object", "x-route-path": "/access_grants/unmanaged" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "access_grants", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Unmanaged Access Grants", "tags": [], "x-response-key": "access_grants", "x-title": "List Unmanaged Access Grants", "x-mint": { "href": "/api/access_grants/unmanaged/list" } } }, "/access_grants/unmanaged/update": { "patch": { "description": "Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.", "operationId": "accessGrantsUnmanagedUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of the unmanaged Access Grant to update.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Unique key for the access grant. If not provided, the existing key will be preserved.", "type": "string" }, "is_managed": { "description": "Must be set to true to convert the unmanaged access grant to managed.", "enum": [ true ], "type": "boolean" } }, "required": [ "access_grant_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/unmanaged/update", "tags": [], "x-fern-sdk-group-name": [ "access_grants", "unmanaged" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Unmanaged Access Grant" }, "post": { "description": "Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.", "operationId": "accessGrantsUnmanagedUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of the unmanaged Access Grant to update.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Unique key for the access grant. If not provided, the existing key will be preserved.", "type": "string" }, "is_managed": { "description": "Must be set to true to convert the unmanaged access grant to managed.", "enum": [ true ], "type": "boolean" } }, "required": [ "access_grant_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Update an Unmanaged Access Grant", "tags": [], "x-response-key": null, "x-title": "Update an Unmanaged Access Grant", "x-mint": { "href": "/api/access_grants/unmanaged/update" } } }, "/access_grants/update": { "patch": { "description": "Updates an existing Access Grant's time window.", "operationId": "accessGrantsUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "minLength": 1, "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", "nullable": true, "type": "string" }, "name": { "description": "Display name for the access grant.", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_grants/update", "tags": [], "x-fern-sdk-group-name": [ "access_grants" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Access Grant" }, "post": { "description": "Updates an existing Access Grant's time window.", "operationId": "accessGrantsUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "minLength": 1, "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", "nullable": true, "type": "string" }, "name": { "description": "Display name for the access grant.", "nullable": true, "type": "string" }, "starts_at": { "description": "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Update an Access Grant", "tags": [], "x-response-key": null, "x-title": "Update an Access Grant", "x-mint": { "href": "/api/access_grants/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessGrants.update({\n access_grant_id: \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\",\n starts_at: \"2025-06-19T18:01:32.000Z\",\n ends_at: \"2025-06-22T13:24:50.000Z\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_grants->update(\n access_grant_id: \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\",\n starts_at: \"2025-06-19T18:01:32.000Z\",\n ends_at: \"2025-06-22T13:24:50.000Z\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-grants update --access_grant_id \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\" --starts_at \"2025-06-19T18:01:32.000Z\" --ends_at \"2025-06-22T13:24:50.000Z\"\n\n# {}" } ] } }, "/access_methods/assign_card": { "post": { "description": "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 triggers issuance of the access method.", "operationId": "accessMethodsAssignCardPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of the `access_method` to assign the credential to.", "format": "uuid", "type": "string" }, "card_number": { "description": "Card number of the credential to assign.", "type": "string" } }, "required": [ "access_method_id", "card_number" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "ASSIGN_CREDENTIAL" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Assign a Card Credential to an Access Method", "tags": [], "x-action-attempt-type": "ASSIGN_CREDENTIAL", "x-response-key": "action_attempt", "x-title": "Assign a Card Credential to an Access Method", "x-mint": { "href": "/api/access_methods/assign_card" } } }, "/access_methods/delete": { "delete": { "description": "Deletes an access method.", "operationId": "accessMethodsDeleteDelete", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_methods/delete", "tags": [], "x-fern-sdk-group-name": [ "access_methods" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Access Method" }, "post": { "description": "Deletes an access method.", "operationId": "accessMethodsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "access_method_id": { "description": "ID of access method to delete.", "format": "uuid", "type": "string" } }, "required": [ "access_method_id" ], "type": "object" }, { "properties": { "access_grant_id": { "description": "ID of access grant whose access methods should be deleted.", "format": "uuid", "type": "string" } }, "required": [ "access_grant_id" ], "type": "object" }, { "properties": { "reservation_key": { "description": "Reservation key of the access grant whose access methods should be deleted.", "type": "string" } }, "required": [ "reservation_key" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Delete an Access Method", "tags": [], "x-response-key": null, "x-title": "Delete an Access Method", "x-mint": { "href": "/api/access_methods/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessMethods.delete({\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_methods->delete(\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-methods delete --access_method_id \"3f10d86c-526b-4b85-8788-cc1a74411b71\"\n\n# {}" } ] } }, "/access_methods/encode": { "post": { "description": "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).", "operationId": "accessMethodsEncodePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of the `access_method` to encode onto a card.", "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the `acs_encoder` to use to encode the `access_method`.", "format": "uuid", "type": "string" } }, "required": [ "acs_encoder_id", "access_method_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "ENCODE_CREDENTIAL" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Encode an Access Method", "tags": [], "x-action-attempt-type": "ENCODE_CREDENTIAL", "x-response-key": "action_attempt", "x-title": "Encode an Access Method", "x-mint": { "href": "/api/access_methods/encode" } } }, "/access_methods/get": { "get": { "description": "Gets an access method.", "operationId": "accessMethodsGetGet", "parameters": [ { "in": "query", "name": "access_method_id", "required": true, "schema": { "description": "ID of access method to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_method": { "$ref": "#/components/schemas/access_method" }, "ok": { "type": "boolean" } }, "required": [ "access_method", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_methods/get", "tags": [], "x-fern-sdk-group-name": [ "access_methods" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method", "x-response-key": "access_method", "x-title": "Get an Access Method" }, "post": { "description": "Gets an access method.", "operationId": "accessMethodsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of access method to get.", "format": "uuid", "type": "string" } }, "required": [ "access_method_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_method": { "$ref": "#/components/schemas/access_method" } }, "required": [ "access_method" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Access Method", "tags": [], "x-response-key": "access_method", "x-title": "Get an Access Method", "x-mint": { "href": "/api/access_methods/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessMethods.get({\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n});\n\n/*\n{\n \"access_method_id\": \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n \"created_at\": \"2025-06-14T16:54:17.946612Z\",\n \"display_name\": \"My Mobile Key\",\n \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\": false,\n \"mode\": \"mobile_key\",\n \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n \"created_at\" => \"2025-06-14T16:54:17.946612Z\",\n \"display_name\" => \"My Mobile Key\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_methods->get(\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n);\n\n// [\n \"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n \"created_at\" => \"2025-06-14T16:54:17.946612Z\",\n \"display_name\" => \"My Mobile Key\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-methods get --access_method_id \"7410aea4-6bed-490c-a602-dd417d9cd075\"\n\n# {\n# \"access_method_id\": \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n# \"created_at\": \"2025-06-14T16:54:17.946612Z\",\n# \"display_name\": \"My Mobile Key\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"is_card_encoding_required\": false,\n# \"mode\": \"mobile_key\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# }" } ] } }, "/access_methods/get_related": { "get": { "description": "Gets all related resources for one or more Access Methods.", "operationId": "accessMethodsGetRelatedGet", "parameters": [ { "in": "query", "name": "access_method_ids", "required": true, "schema": { "description": "IDs of the access methods that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_grants": { "items": { "$ref": "#/components/schemas/access_grant" }, "type": "array" }, "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "client_sessions": { "items": { "$ref": "#/components/schemas/client_session" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "instant_keys": { "items": { "$ref": "#/components/schemas/instant_key" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": [ "batch", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_methods/get_related", "tags": [], "x-batch-keys": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "x-fern-sdk-group-name": [ "access_methods" ], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch", "x-response-key": "batch", "x-title": "Get related Access Method resources" }, "post": { "description": "Gets all related resources for one or more Access Methods.", "operationId": "accessMethodsGetRelatedPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_ids": { "description": "IDs of the access methods that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "exclude": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "type": "string" }, "type": "array" }, "include": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "access_grants", "access_methods", "instant_keys", "client_sessions", "acs_credentials" ], "type": "string" }, "type": "array" } }, "required": [ "access_method_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_grants": { "items": { "$ref": "#/components/schemas/access_grant" }, "type": "array" }, "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "client_sessions": { "items": { "$ref": "#/components/schemas/client_session" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "instant_keys": { "items": { "$ref": "#/components/schemas/instant_key" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" } }, "required": [ "batch" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get related Access Method resources", "tags": [], "x-response-key": "batch", "x-title": "Get related Access Method resources", "x-mint": { "href": "/api/access_methods/get_related" } } }, "/access_methods/list": { "get": { "description": "Lists all access methods, usually filtered by Access Grant.", "operationId": "accessMethodsListGet", "parameters": [ { "in": "query", "name": "access_grant_id", "schema": { "description": "ID of Access Grant to list access methods for.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_key", "schema": { "description": "Key of Access Grant to list access methods for.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "device_id", "schema": { "description": "ID of the device for which you want to retrieve all access methods.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_id", "schema": { "description": "ID of the entrance for which you want to retrieve all access methods.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to retrieve all access methods.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_id", "schema": { "description": "ID of the access code for which you want to retrieve all access methods.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "access_methods", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_methods/list", "tags": [], "x-fern-sdk-group-name": [ "access_methods" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods", "x-response-key": "access_methods", "x-title": "List Access Methods" }, "post": { "description": "Lists all access methods, usually filtered by Access Grant.", "operationId": "accessMethodsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code for which you want to retrieve all access methods.", "format": "uuid", "type": "string" }, "access_grant_id": { "description": "ID of Access Grant to list access methods for.", "format": "uuid", "type": "string" }, "access_grant_key": { "description": "Key of Access Grant to list access methods for.", "minLength": 1, "type": "string" }, "acs_entrance_id": { "description": "ID of the entrance for which you want to retrieve all access methods.", "format": "uuid", "type": "string" }, "device_id": { "description": "ID of the device for which you want to retrieve all access methods.", "format": "uuid", "type": "string" }, "space_id": { "description": "ID of the space for which you want to retrieve all access methods.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" } }, "required": [ "access_methods" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Access Methods", "tags": [], "x-response-key": "access_methods", "x-title": "List Access Methods", "x-mint": { "href": "/api/access_methods/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.accessMethods.list({\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n});\n\n/*\n[\n {\n \"access_method_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"PIN Code Credential\",\n \"is_card_encoding_required\": false,\n \"mode\": \"code\",\n \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n },\n {\n \"access_method_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n \"display_name\": \"Card Credential\",\n \"is_card_encoding_required\": true,\n \"mode\": \"card\",\n \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n },\n {\n \"access_method_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n \"display_name\": \"Mobile Key Credential\",\n \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\": false,\n \"mode\": \"mobile_key\",\n \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"PIN Code Credential\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"code\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"display_name\" => \"Card Credential\",\n \"is_card_encoding_required\" => true,\n \"mode\" => \"card\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"display_name\" => \"Mobile Key Credential\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->access_methods->list(\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n);\n\n// [\n [\n \"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"PIN Code Credential\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"code\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n ],\n [\n \"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"display_name\" => \"Card Credential\",\n \"is_card_encoding_required\" => true,\n \"mode\" => \"card\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n ],\n [\n \"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"display_name\" => \"Mobile Key Credential\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam access-methods list --access_grant_id \"9072ebcd-95f3-4e4b-8f2f-10053911533b\"\n\n# [\n# {\n# \"access_method_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"PIN Code Credential\",\n# \"is_card_encoding_required\": false,\n# \"mode\": \"code\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# },\n# {\n# \"access_method_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n# \"display_name\": \"Card Credential\",\n# \"is_card_encoding_required\": true,\n# \"mode\": \"card\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# },\n# {\n# \"access_method_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n# \"display_name\": \"Mobile Key Credential\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"is_card_encoding_required\": false,\n# \"mode\": \"mobile_key\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# }\n# ]" } ] } }, "/access_methods/unlock_door": { "post": { "description": "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.", "operationId": "accessMethodsUnlockDoorPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of the cloud_key `access_method` to use for the unlock operation.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the entrance to unlock.", "format": "uuid", "type": "string" } }, "required": [ "access_method_id", "acs_entrance_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "UNLOCK_DOOR" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Unlock a Door with an Access Method", "tags": [], "x-action-attempt-type": "UNLOCK_DOOR", "x-response-key": "action_attempt", "x-title": "Unlock a Door with an Access Method", "x-mint": { "href": "/api/access_methods/unlock_door" } } }, "/access_methods/unmanaged/get": { "get": { "description": "Gets an unmanaged access method (where is_managed = false).", "operationId": "accessMethodsUnmanagedGetGet", "parameters": [ { "in": "query", "name": "access_method_id", "required": true, "schema": { "description": "ID of unmanaged access method to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_method": { "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_method_id": { "description": "ID of the access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access method was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "is_assignment_required": { "description": "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.", "type": "boolean" }, "is_encoding_required": { "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.", "type": "boolean" }, "is_issued": { "description": "Indicates whether the access method has been issued.", "type": "boolean" }, "is_ready_for_assignment": { "description": "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.", "type": "boolean" }, "is_ready_for_encoding": { "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the access method was issued.", "format": "date-time", "nullable": true, "type": "string" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "pending_mutations": { "description": "Pending mutations for the [access method](/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of provisioning access for this access method on new devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access was provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.", "enum": [ "provisioning_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access is being provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of revoking access for this access method from devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.", "enum": [ "revoking_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access should remain.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access method.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "items": { "description": "Warning associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access method](/use-cases/granting-access/creating-an-access-grant) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access method](/use-cases/granting-access/creating-an-access-grant) are being updated.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "original_access_method_id": { "description": "ID of the original access method from which this backup access method was split, if applicable.", "format": "uuid", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "pulled_backup_access_code" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the access method.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "type": "object", "x-route-path": "/access_methods/unmanaged" }, "ok": { "type": "boolean" } }, "required": [ "access_method", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/access_methods/unmanaged/get", "tags": [], "x-fern-sdk-group-name": [ "access_methods", "unmanaged" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "access_method", "x-response-key": "access_method", "x-title": "Get an Unmanaged Access Method" }, "post": { "description": "Gets an unmanaged access method (where is_managed = false).", "operationId": "accessMethodsUnmanagedGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of unmanaged access method to get.", "format": "uuid", "type": "string" } }, "required": [ "access_method_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_method": { "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_method_id": { "description": "ID of the access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access method was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "is_assignment_required": { "description": "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.", "type": "boolean" }, "is_encoding_required": { "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.", "type": "boolean" }, "is_issued": { "description": "Indicates whether the access method has been issued.", "type": "boolean" }, "is_ready_for_assignment": { "description": "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.", "type": "boolean" }, "is_ready_for_encoding": { "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the access method was issued.", "format": "date-time", "nullable": true, "type": "string" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "pending_mutations": { "description": "Pending mutations for the [access method](/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of provisioning access for this access method on new devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access was provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.", "enum": [ "provisioning_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access is being provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of revoking access for this access method from devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.", "enum": [ "revoking_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access should remain.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access method.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "items": { "description": "Warning associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access method](/use-cases/granting-access/creating-an-access-grant) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access method](/use-cases/granting-access/creating-an-access-grant) are being updated.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "original_access_method_id": { "description": "ID of the original access method from which this backup access method was split, if applicable.", "format": "uuid", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "pulled_backup_access_code" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the access method.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "type": "object", "x-route-path": "/access_methods/unmanaged" } }, "required": [ "access_method" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Unmanaged Access Method", "tags": [], "x-response-key": "access_method", "x-title": "Get an Unmanaged Access Method", "x-mint": { "href": "/api/access_methods/unmanaged/get" } } }, "/access_methods/unmanaged/list": { "get": { "description": "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.", "operationId": "accessMethodsUnmanagedListGet", "parameters": [ { "in": "query", "name": "access_grant_id", "required": true, "schema": { "description": "ID of Access Grant to list unmanaged access methods for.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_id", "required": false, "schema": { "description": "ID of the device for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_id", "required": false, "schema": { "description": "ID of the entrance for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "space_id", "required": false, "schema": { "description": "ID of the space for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_methods": { "items": { "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_method_id": { "description": "ID of the access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access method was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "is_assignment_required": { "description": "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.", "type": "boolean" }, "is_encoding_required": { "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.", "type": "boolean" }, "is_issued": { "description": "Indicates whether the access method has been issued.", "type": "boolean" }, "is_ready_for_assignment": { "description": "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.", "type": "boolean" }, "is_ready_for_encoding": { "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the access method was issued.", "format": "date-time", "nullable": true, "type": "string" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "pending_mutations": { "description": "Pending mutations for the [access method](/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of provisioning access for this access method on new devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access was provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.", "enum": [ "provisioning_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access is being provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of revoking access for this access method from devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.", "enum": [ "revoking_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access should remain.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access method.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "items": { "description": "Warning associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access method](/use-cases/granting-access/creating-an-access-grant) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access method](/use-cases/granting-access/creating-an-access-grant) are being updated.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "original_access_method_id": { "description": "ID of the original access method from which this backup access method was split, if applicable.", "format": "uuid", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "pulled_backup_access_code" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the access method.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "type": "object", "x-route-path": "/access_methods/unmanaged" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "access_methods", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/access_methods/unmanaged/list", "tags": [], "x-fern-sdk-group-name": [ "access_methods", "unmanaged" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "access_methods", "x-response-key": "access_methods", "x-title": "List Unmanaged Access Methods" }, "post": { "description": "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.", "operationId": "accessMethodsUnmanagedListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_id": { "description": "ID of Access Grant to list unmanaged access methods for.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the entrance for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" }, "device_id": { "description": "ID of the device for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" }, "space_id": { "description": "ID of the space for which you want to retrieve all unmanaged access methods.", "format": "uuid", "type": "string" } }, "required": [ "access_grant_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_methods": { "items": { "description": "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.", "properties": { "access_method_id": { "description": "ID of the access method.", "format": "uuid", "type": "string" }, "code": { "description": "The actual PIN code for code access methods.", "nullable": true, "type": "string" }, "created_at": { "description": "Date and time at which the access method was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name of the access method.", "type": "string" }, "is_assignment_required": { "description": "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.", "type": "boolean" }, "is_encoding_required": { "description": "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.", "type": "boolean" }, "is_issued": { "description": "Indicates whether the access method has been issued.", "type": "boolean" }, "is_ready_for_assignment": { "description": "Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.", "type": "boolean" }, "is_ready_for_encoding": { "description": "Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.", "type": "boolean" }, "issued_at": { "description": "Date and time at which the access method was issued.", "format": "date-time", "nullable": true, "type": "string" }, "mode": { "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "pending_mutations": { "description": "Pending mutations for the [access method](/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.", "items": { "discriminator": { "propertyName": "mutation_code" }, "oneOf": [ { "description": "Seam is in the process of provisioning access for this access method on new devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access was provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.", "enum": [ "provisioning_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access is being provisioned.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of revoking access for this access method from devices.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous device configuration.", "properties": { "device_ids": { "description": "Previous device IDs where access existed.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.", "enum": [ "revoking_access" ], "type": "string" }, "to": { "description": "New device configuration.", "properties": { "device_ids": { "description": "New device IDs where access should remain.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "device_ids" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" }, { "description": "Seam is in the process of updating the access times for this access method.", "properties": { "created_at": { "description": "Date and time at which the mutation was created.", "format": "date-time", "type": "string" }, "from": { "description": "Previous access time configuration.", "properties": { "ends_at": { "description": "Previous end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Previous start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "message": { "description": "Detailed description of the mutation.", "type": "string" }, "mutation_code": { "description": "Mutation code to indicate that Seam is in the process of updating the access times for this access method.", "enum": [ "updating_access_times" ], "type": "string" }, "to": { "description": "New access time configuration.", "properties": { "ends_at": { "description": "New end time for access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "New start time for access.", "format": "date-time", "nullable": true, "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" } }, "required": [ "created_at", "message", "mutation_code", "from", "to" ], "type": "object" } ] }, "type": "array" }, "warnings": { "description": "Warnings associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "items": { "description": "Warning associated with the [access method](/use-cases/granting-access/creating-an-access-grant).", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the [access method](/use-cases/granting-access/creating-an-access-grant) is being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the access times for this [access method](/use-cases/granting-access/creating-an-access-grant) are being updated.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "updating_access_times" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "original_access_method_id": { "description": "ID of the original access method from which this backup access method was split, if applicable.", "format": "uuid", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "pulled_backup_access_code" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the Seam workspace associated with the access method.", "format": "uuid", "type": "string" } }, "required": [ "workspace_id", "access_method_id", "display_name", "mode", "created_at", "issued_at", "is_issued", "warnings", "pending_mutations" ], "type": "object", "x-route-path": "/access_methods/unmanaged" }, "type": "array" } }, "required": [ "access_methods" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Unmanaged Access Methods", "tags": [], "x-response-key": "access_methods", "x-title": "List Unmanaged Access Methods", "x-mint": { "href": "/api/access_methods/unmanaged/list" } } }, "/acs/access_groups/add_user": { "post": { "description": "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).", "operationId": "acsAccessGroupsAddUserPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group to which you want to add an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Add an ACS User to an Access Group", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Add an ACS User to an Access Group", "x-mint": { "href": "/api/acs/access_groups/add_user" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.addUser({\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/add_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->add_user(\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups add-user --acs_access_group_id \"55efa954-2b84-42af-8d05-fc1f892df51c\" --acs_user_id \"ebf54c67-746c-471f-a03f-86665148a84c\"\n\n# {}" } ] }, "put": { "description": "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).", "operationId": "acsAccessGroupsAddUserPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group to which you want to add an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/add_user", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "add_user", "x-response-key": null, "x-title": "Add an ACS User to an Access Group" } }, "/acs/access_groups/delete": { "delete": { "description": "Deletes a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsDeleteDelete", "parameters": [ { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/delete", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Access Group" }, "post": { "description": "Deletes a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete an Access Group", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Delete an Access Group", "x-mint": { "href": "/api/acs/access_groups/delete" } } }, "/acs/access_groups/get": { "get": { "description": "Returns a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsGetGet", "parameters": [ { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_access_group": { "$ref": "#/components/schemas/acs_access_group" }, "ok": { "type": "boolean" } }, "required": [ "acs_access_group", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_access_group", "x-response-key": "acs_access_group", "x-title": "Get an Access Group" }, "post": { "description": "Returns a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_access_group": { "$ref": "#/components/schemas/acs_access_group" } }, "required": [ "acs_access_group" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Access Group", "tags": [ "/acs" ], "x-response-key": "acs_access_group", "x-title": "Get an Access Group", "x-mint": { "href": "/api/acs/access_groups/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.get({\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n});\n\n/*\n{\n \"access_group_type\": \"salto_ks_access_group\",\n \"access_group_type_display_name\": \"Salto KS Access Group\",\n \"acs_access_group_id\": \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n \"acs_system_id\": \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n \"display_name\": \"Main Group\",\n \"external_type\": \"salto_ks_access_group\",\n \"external_type_display_name\": \"Salto KS Access Group\",\n \"is_managed\": true,\n \"name\": \"My Access Group\",\n \"pending_mutations\": [],\n \"warnings\": [],\n \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n \"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->get(\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n);\n\n// [\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n \"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups get --acs_access_group_id \"09eb5265-6e3b-4e6d-bf96-736171c547ae\"\n\n# {\n# \"access_group_type\": \"salto_ks_access_group\",\n# \"access_group_type_display_name\": \"Salto KS Access Group\",\n# \"acs_access_group_id\": \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n# \"acs_system_id\": \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n# \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n# \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n# \"display_name\": \"Main Group\",\n# \"external_type\": \"salto_ks_access_group\",\n# \"external_type_display_name\": \"Salto KS Access Group\",\n# \"is_managed\": true,\n# \"name\": \"My Access Group\",\n# \"pending_mutations\": [],\n# \"warnings\": [],\n# \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n# }" } ] } }, "/acs/access_groups/list": { "get": { "description": "Returns a list of all [access groups](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListGet", "parameters": [ { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system for which you want to retrieve all access groups.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_user_id", "schema": { "description": "ID of the access system user for which you want to retrieve all access groups.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity for which you want to retrieve all access groups.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_access_groups": { "items": { "$ref": "#/components/schemas/acs_access_group" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_access_groups", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_access_groups", "x-response-key": "acs_access_groups", "x-title": "List Access Groups" }, "post": { "description": "Returns a list of all [access groups](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to retrieve all access groups.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user for which you want to retrieve all access groups.", "format": "uuid", "type": "string" }, "search": { "description": "String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.", "minLength": 1, "type": "string" }, "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all access groups.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_access_groups": { "items": { "$ref": "#/components/schemas/acs_access_group" }, "type": "array" } }, "required": [ "acs_access_groups" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Access Groups", "tags": [ "/acs" ], "x-response-key": "acs_access_groups", "x-title": "List Access Groups", "x-mint": { "href": "/api/acs/access_groups/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.list({\n acs_system_id: \"1b529056-1b04-450b-b3da-016b65a5017f\",\n acs_user_id: \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\",\n user_identity_id: \"9b1deda4-07e2-4e90-acde-5724b6ab7305\",\n});\n\n/*\n[\n {\n \"access_group_type\": \"salto_ks_access_group\",\n \"access_group_type_display_name\": \"Salto KS Access Group\",\n \"acs_access_group_id\": \"3f448826-9875-4947-9519-e468090a4f7d\",\n \"acs_system_id\": \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n \"display_name\": \"Main Group\",\n \"external_type\": \"salto_ks_access_group\",\n \"external_type_display_name\": \"Salto KS Access Group\",\n \"is_managed\": true,\n \"name\": \"My Access Group\",\n \"pending_mutations\": [],\n \"warnings\": [],\n \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\n \"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->list(\n acs_system_id: \"1b529056-1b04-450b-b3da-016b65a5017f\",\n acs_user_id: \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\",\n user_identity_id: \"9b1deda4-07e2-4e90-acde-5724b6ab7305\",\n);\n\n// [\n [\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\n \"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups list --acs_system_id \"1b529056-1b04-450b-b3da-016b65a5017f\" --acs_user_id \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\" --user_identity_id \"9b1deda4-07e2-4e90-acde-5724b6ab7305\"\n\n# [\n# {\n# \"access_group_type\": \"salto_ks_access_group\",\n# \"access_group_type_display_name\": \"Salto KS Access Group\",\n# \"acs_access_group_id\": \"3f448826-9875-4947-9519-e468090a4f7d\",\n# \"acs_system_id\": \"1b529056-1b04-450b-b3da-016b65a5017f\",\n# \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n# \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n# \"display_name\": \"Main Group\",\n# \"external_type\": \"salto_ks_access_group\",\n# \"external_type_display_name\": \"Salto KS Access Group\",\n# \"is_managed\": true,\n# \"name\": \"My Access Group\",\n# \"pending_mutations\": [],\n# \"warnings\": [],\n# \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n# }\n# ]" } ] } }, "/acs/access_groups/list_accessible_entrances": { "get": { "description": "Returns a list of all accessible entrances for a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListAccessibleEntrancesGet", "parameters": [ { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group for which you want to retrieve all accessible entrances.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_entrances", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/acs/access_groups/list_accessible_entrances", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances", "x-response-key": "acs_entrances", "x-title": "List Entrances Accessible to an Access Group" }, "post": { "description": "Returns a list of all accessible entrances for a specified [access group](/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).", "operationId": "acsAccessGroupsListAccessibleEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group for which you want to retrieve all accessible entrances.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" } }, "required": [ "acs_entrances" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Entrances Accessible to an Access Group", "tags": [ "/acs" ], "x-response-key": "acs_entrances", "x-title": "List Entrances Accessible to an Access Group", "x-mint": { "href": "/api/acs/access_groups/list_accessible_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.listAccessibleEntrances({\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n});\n\n/*\n[\n {\n \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n \"display_name\": \"Main Entrance\",\n \"errors\": [],\n \"visionline_metadata\": {\n \"door_category\": \"guest\",\n \"door_name\": \"Main Entrance\",\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ]\n }\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->list_accessible_entrances(\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n);\n\n// [\n [\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => [\n \"door_category\" => \"guest\",\n \"door_name\" => \"Main Entrance\",\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups list-accessible-entrances --acs_access_group_id \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\"\n\n# [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]" } ] } }, "/acs/access_groups/list_users": { "get": { "description": "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).", "operationId": "acsAccessGroupsListUsersGet", "parameters": [ { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_users", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/list_users", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "list_users", "x-fern-sdk-return-value": "acs_users", "x-response-key": "acs_users", "x-title": "List ACS Users in an Access Group" }, "post": { "description": "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).", "operationId": "acsAccessGroupsListUsersPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" } }, "required": [ "acs_users" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List ACS Users in an Access Group", "tags": [ "/acs" ], "x-response-key": "acs_users", "x-title": "List ACS Users in an Access Group", "x-mint": { "href": "/api/acs/access_groups/list_users" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.listUsers({\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n});\n\n/*\n[\n {\n \"access_schedule\": {\n \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n },\n \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"external_type\": \"salto_site_user\",\n \"external_type_display_name\": \"Salto site user\",\n \"full_name\": \"Jane Doe\",\n \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\": true,\n \"is_suspended\": false,\n \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\": [],\n \"phone_number\": \"+1555551000\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\": \"+1555551000\",\n \"warnings\": [],\n \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->list_users(\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n);\n\n// [\n [\n \"access_schedule\" => [\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n ],\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups list-users --acs_access_group_id \"da76b0a9-97c5-4d7c-8db2-91d13094a940\"\n\n# [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]" } ] } }, "/acs/access_groups/remove_user": { "delete": { "description": "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).", "operationId": "acsAccessGroupsRemoveUserDelete", "parameters": [ { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group from which you want to remove an access system user.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_user_id", "required": false, "schema": { "description": "ID of the access system user that you want to remove from an access group.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "required": false, "schema": { "description": "ID of the user identity associated with the user that you want to remove from an access group.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/access_groups/remove_user", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "access_groups" ], "x-fern-sdk-method-name": "remove_user", "x-response-key": null, "x-title": "Remove an ACS User from an Access Group" }, "post": { "description": "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).", "operationId": "acsAccessGroupsRemoveUserPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group from which you want to remove an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to remove from an access group.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity associated with the user that you want to remove from an access group.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Remove an ACS User from an Access Group", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Remove an ACS User from an Access Group", "x-mint": { "href": "/api/acs/access_groups/remove_user" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.accessGroups.removeUser({\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/remove_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->access_groups->remove_user(\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs access-groups remove-user --acs_access_group_id \"e320069d-59ba-4adb-a465-f4f01a833e07\" --user_identity_id \"3d662a00-5d7c-41b4-aee7-16c385964149\"\n\n# {}" } ] } }, "/acs/credentials/assign": { "patch": { "description": "Assigns a specified [credential](/low-level-apis/access-systems/managing-credentials) to a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsCredentialsAssignPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to assign to an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": [ "acs_credential", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/credentials/assign", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "assign", "x-response-key": null, "x-title": "Assign a Credential to an ACS User" }, "post": { "description": "Assigns a specified [credential](/low-level-apis/access-systems/managing-credentials) to a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsCredentialsAssignPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to assign to an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Assign a Credential to an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Assign a Credential to an ACS User", "x-mint": { "href": "/api/acs/credentials/assign" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.assign({\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/assign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->assign(\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials assign --user_identity_id \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\" --acs_credential_id \"59c9af06-7881-46d2-8d9b-3eda964c058b\"\n\n# {}" } ] } }, "/acs/credentials/create": { "post": { "description": "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, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.", "operationId": "acsCredentialsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method": { "description": "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.", "enum": [ "code", "card", "mobile_key", "cloud_key" ], "type": "string" }, "acs_system_id": { "description": "ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.", "format": "uuid", "type": "string" }, "allowed_acs_entrance_ids": { "default": [], "description": "Set of IDs of the [entrances](/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "assa_abloy_vostio_metadata": { "description": "Vostio-specific metadata for the new credential.", "properties": { "auto_join": { "type": "boolean" }, "join_all_guest_acs_entrances": { "type": "boolean" }, "override_all_guest_acs_entrances": { "type": "boolean" }, "override_guest_acs_entrance_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "code": { "description": "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](/device-and-system-integration-guides).", "pattern": "^\\d+$", "type": "string" }, "credential_manager_acs_system_id": { "description": "ACS system ID of the credential manager for the new credential.", "format": "uuid", "type": "string" }, "ends_at": { "description": "Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", "type": "string" }, "is_multi_phone_sync_credential": { "default": false, "description": "Indicates whether the new credential is a [multi-phone sync credential](/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", "type": "boolean" }, "salto_space_metadata": { "description": "Salto Space-specific metadata for the new credential.", "properties": { "assign_new_key": { "description": "Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).", "type": "boolean" } }, "type": "object" }, "starts_at": { "description": "Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.", "format": "uuid", "type": "string" }, "visionline_metadata": { "description": "Visionline-specific metadata for the new credential.", "properties": { "auto_join": { "type": "boolean" }, "card_format": { "enum": [ "TLCode", "rfid48" ], "type": "string" }, "card_function_type": { "default": "guest", "enum": [ "guest", "staff" ], "type": "string" }, "joiner_acs_credential_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "override": { "type": "boolean" } }, "type": "object" } }, "required": [ "access_method" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" } }, "required": [ "acs_credential" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create a Credential for an ACS User", "tags": [ "/acs" ], "x-response-key": "acs_credential", "x-title": "Create a Credential for an ACS User", "x-mint": { "href": "/api/acs/credentials/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.create({\n credential_manager_acs_system_id: \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\",\n user_identity_id: \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\",\n acs_system_id: \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n access_method: \"code\",\n code: \"1234\",\n allowed_acs_entrance_ids: [\"21805570-4706-4c21-99fc-3ed873a5e014\"],\n starts_at: \"2025-06-19T21:08:08.000Z\",\n ends_at: \"2025-06-23T12:35:01.000Z\",\n});\n\n/*\n{\n \"access_method\": \"code\",\n \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\": \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"acs_user_id\": \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n \"code\": \"1234\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"Salto KS Credential\",\n \"errors\": [],\n \"external_type\": \"salto_ks_credential\",\n \"external_type_display_name\": \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": true,\n \"is_one_time_use\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-06-19T21:08:08.000Z\",\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Salto KS Credential\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => true,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-06-19T21:08:08.000Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->create(\n credential_manager_acs_system_id: \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\",\n user_identity_id: \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\",\n acs_system_id: \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n access_method: \"code\",\n code: \"1234\",\n allowed_acs_entrance_ids: [\"21805570-4706-4c21-99fc-3ed873a5e014\"],\n starts_at: \"2025-06-19T21:08:08.000Z\",\n ends_at: \"2025-06-23T12:35:01.000Z\",\n);\n\n// [\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Salto KS Credential\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => true,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-06-19T21:08:08.000Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials create --credential_manager_acs_system_id \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\" --user_identity_id \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\" --acs_system_id \"7113de29-6130-4153-a6ea-1b7ca0fe3198\" --access_method \"code\" --code \"1234\" --allowed_acs_entrance_ids [\"21805570-4706-4c21-99fc-3ed873a5e014\"] --starts_at \"2025-06-19T21:08:08.000Z\" --ends_at \"2025-06-23T12:35:01.000Z\"\n\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n# \"acs_user_id\": \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Salto KS Credential\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": true,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-06-19T21:08:08.000Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }" } ] } }, "/acs/credentials/delete": { "delete": { "description": "Deletes a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsDeleteDelete", "parameters": [ { "in": "query", "name": "acs_credential_id", "required": true, "schema": { "description": "ID of the credential that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/credentials/delete", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Credential" }, "post": { "description": "Deletes a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete a Credential", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Delete a Credential", "x-mint": { "href": "/api/acs/credentials/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.delete({\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->delete(\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials delete --acs_credential_id \"33bbceea-221e-48bd-8d38-aa72f88a1cab\"\n\n# {}" } ] } }, "/acs/credentials/get": { "get": { "description": "Returns a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsGetGet", "parameters": [ { "in": "query", "name": "acs_credential_id", "required": true, "schema": { "description": "ID of the credential that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": [ "acs_credential", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/credentials/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_credential", "x-response-key": "acs_credential", "x-title": "Get a Credential" }, "post": { "description": "Returns a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" } }, "required": [ "acs_credential" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Credential", "tags": [ "/acs" ], "x-response-key": "acs_credential", "x-title": "Get a Credential", "x-mint": { "href": "/api/acs/credentials/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.get({\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n});\n\n/*\n{\n \"access_method\": \"code\",\n \"acs_credential_id\": \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\": \"123456\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"FRONT_DOOR\",\n \"errors\": [],\n \"external_type\": \"salto_ks_credential\",\n \"external_type_display_name\": \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": false,\n \"is_one_time_use\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->get(\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n);\n\n// [\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials get --acs_credential_id \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"\n\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"code\": \"123456\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"FRONT_DOOR\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }" } ] } }, "/acs/credentials/list": { "get": { "description": "Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsListGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_credentials", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/acs/credentials/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_credentials", "x-response-key": "acs_credentials", "x-title": "List Credentials" }, "post": { "description": "Returns a list of all [credentials](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsListPost", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "properties": { "acs_user_id": { "description": "ID of the access system user for which you want to retrieve all credentials.", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" }, { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to retrieve all credentials.", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id" ], "type": "object" }, { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to retrieve all credentials.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user for which you want to retrieve all credentials.", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id", "acs_system_id" ], "type": "object" }, { "properties": { "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all credentials.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" }, { "properties": {}, "type": "object" } ] }, { "properties": { "created_before": { "description": "Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.", "format": "date-time", "type": "string" }, "is_multi_phone_sync_credential": { "description": "Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.", "type": "boolean" }, "limit": { "default": 500, "description": "Number of credentials to return.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.", "minLength": 1, "type": "string" } }, "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_credentials", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Credentials", "tags": [ "/acs" ], "x-response-key": "acs_credentials", "x-title": "List Credentials", "x-mint": { "href": "/api/acs/credentials/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.list();\n\n/*\n[\n {\n \"access_method\": \"code\",\n \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\": \"123456\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"FRONT_DOOR\",\n \"errors\": [],\n \"external_type\": \"salto_ks_credential\",\n \"external_type_display_name\": \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": false,\n \"is_one_time_use\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"acs_credentials\": [\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"code\": \"123456\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"FRONT_DOOR\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.acs.credentials.list()\n\n# [\n AcsCredential(\n access_method=\"code\",\n acs_credential_id=\"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id=\"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id=\"0fc82df4-391b-4d00-a234-86378f1c3952\",\n code=\"123456\",\n created_at=\"2025-06-16T16:54:17.946514Z\",\n display_name=\"FRONT_DOOR\",\n errors=[],\n external_type=\"salto_ks_credential\",\n external_type_display_name=\"Salto KS Credential\",\n is_latest_desired_state_synced_with_provider=true,\n is_managed=true,\n is_multi_phone_sync_credential=false,\n is_one_time_use=false,\n latest_desired_state_synced_with_provider_at=\"2025-06-18T16:54:17.946514Z\",\n starts_at=\"2025-07-10T16:54:17.946512Z\",\n warnings=[],\n workspace_id=\"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.acs.credentials.list()\n\n# => [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->list();\n\n// [\n [\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials list\n\n# [\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"code\": \"123456\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"FRONT_DOOR\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }\n# ]" } ] } }, "/acs/credentials/list_accessible_entrances": { "get": { "description": "Returns a list of all [entrances](/api/acs/entrances/object) to which a [credential](/api/acs/credentials/object) grants access.", "operationId": "acsCredentialsListAccessibleEntrancesGet", "parameters": [ { "in": "query", "name": "acs_credential_id", "required": true, "schema": { "description": "ID of the credential for which you want to retrieve all entrances to which the credential grants access.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_entrances", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/acs/credentials/list_accessible_entrances", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances", "x-response-key": "acs_entrances", "x-title": "List Accessible Entrances" }, "post": { "description": "Returns a list of all [entrances](/api/acs/entrances/object) to which a [credential](/api/acs/credentials/object) grants access.", "operationId": "acsCredentialsListAccessibleEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential for which you want to retrieve all entrances to which the credential grants access.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" } }, "required": [ "acs_entrances" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Accessible Entrances", "tags": [ "/acs" ], "x-response-key": "acs_entrances", "x-title": "List Accessible Entrances", "x-mint": { "href": "/api/acs/credentials/list_accessible_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.listAccessibleEntrances({\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n});\n\n/*\n[\n {\n \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n \"display_name\": \"Main Entrance\",\n \"errors\": [],\n \"visionline_metadata\": {\n \"door_category\": \"guest\",\n \"door_name\": \"Main Entrance\",\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ]\n }\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->list_accessible_entrances(\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n);\n\n// [\n [\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => [\n \"door_category\" => \"guest\",\n \"door_name\" => \"Main Entrance\",\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials list-accessible-entrances --acs_credential_id \"9407e456-b8ac-475a-8431-fee76cedda03\"\n\n# [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]" } ] } }, "/acs/credentials/unassign": { "patch": { "description": "Unassigns a specified [credential](/low-level-apis/access-systems/managing-credentials) from a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsCredentialsUnassignPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to unassign from an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": [ "acs_credential", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/credentials/unassign", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "unassign", "x-response-key": null, "x-title": "Unassign a Credential from an ACS User" }, "post": { "description": "Unassigns a specified [credential](/low-level-apis/access-systems/managing-credentials) from a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsCredentialsUnassignPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to unassign from an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Unassign a Credential from an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Unassign a Credential from an ACS User", "x-mint": { "href": "/api/acs/credentials/unassign" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.unassign({\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/unassign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->unassign(\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials unassign --user_identity_id \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\" --acs_credential_id \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\"\n\n# {}" } ] } }, "/acs/credentials/update": { "patch": { "description": "Updates the code and ends at date and time for a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to update.", "type": "string" }, "code": { "description": "Replacement access (PIN) code for the credential that you want to update.", "pattern": "^\\d+$", "type": "string" }, "ends_at": { "description": "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.", "format": "date-time", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credential": { "$ref": "#/components/schemas/acs_credential" }, "ok": { "type": "boolean" } }, "required": [ "acs_credential", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/credentials/update", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "credentials" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Credential" }, "post": { "description": "Updates the code and ends at date and time for a specified [credential](/low-level-apis/access-systems/managing-credentials).", "operationId": "acsCredentialsUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential that you want to update.", "type": "string" }, "code": { "description": "Replacement access (PIN) code for the credential that you want to update.", "pattern": "^\\d+$", "type": "string" }, "ends_at": { "description": "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.", "format": "date-time", "type": "string" } }, "required": [ "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update a Credential", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Update a Credential", "x-mint": { "href": "/api/acs/credentials/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.credentials.update({\n acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\n code: \"1234\",\n ends_at: \"2025-06-18T10:42:53.000Z\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->credentials->update(\n acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\n code: \"1234\",\n ends_at: \"2025-06-18T10:42:53.000Z\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs credentials update --acs_credential_id \"1d4fb22b-743b-492f-ad74-cffcbd63c874\" --code \"1234\" --ends_at \"2025-06-18T10:42:53.000Z\"\n\n# {}" } ] } }, "/acs/encoders/encode_credential": { "post": { "description": "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`", "operationId": "acsEncodersEncodeCredentialPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_method_id": { "description": "ID of the `access_method` to encode onto a card.", "format": "uuid", "type": "string" }, "acs_credential_id": { "description": "ID of the `acs_credential` to encode onto a card.", "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the `acs_encoder` to use to encode the `acs_credential`.", "format": "uuid", "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "ENCODE_CREDENTIAL" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Encode a Credential", "tags": [ "/acs" ], "x-action-attempt-type": "ENCODE_CREDENTIAL", "x-response-key": "action_attempt", "x-title": "Encode a Credential", "x-mint": { "href": "/api/acs/encoders/encode_credential" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.encodeCredential({\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n});\n\n/*\n{\n \"action_attempt_id\": \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n \"action_type\": \"ENCODE_CREDENTIAL\",\n \"error\": null,\n \"result\": {\n \"access_method\": \"card\",\n \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"card_number\": \"164d29dc4a09b65f\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n \"errors\": [],\n \"external_type\": \"visionline_card\",\n \"external_type_display_name\": \"Visionline Card\",\n \"is_issued\": true,\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": false,\n \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\": {\n \"card_function_type\": \"guest\",\n \"card_id\": \"5\",\n \"common_acs_entrance_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n ],\n \"credential_id\": \"15\",\n \"guest_acs_entrance_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ],\n \"is_valid\": true\n },\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n },\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/encode_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n \"action_type\" => \"ENCODE_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->encode_credential(\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n);\n\n// [\n \"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n \"action_type\" => \"ENCODE_CREDENTIAL\",\n \"error\" => null,\n \"result\" => [\n \"access_method\" => \"card\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"card_number\" => \"164d29dc4a09b65f\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Guest Lock 1, Vingcard Lock 2\",\n \"ends_at\" => \"2025-07-12T16:54:17.946512Z\",\n \"errors\" => [],\n \"external_type\" => \"visionline_card\",\n \"external_type_display_name\" => \"Visionline Card\",\n \"is_issued\" => true,\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"issued_at\" => \"2025-06-16T16:54:17.946512Z\",\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\" => [\n \"card_function_type\" => \"guest\",\n \"card_id\" => \"5\",\n \"common_acs_entrance_ids\" => [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n ],\n \"credential_id\" => \"15\",\n \"guest_acs_entrance_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n \"is_valid\" => true,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n ],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders encode-credential --acs_encoder_id \"18ad521a-308e-4182-b1a6-2338b46a2763\" --acs_credential_id \"a383871c-331a-42ae-af66-146824505187\"\n\n# {\n# \"action_attempt_id\": \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n# \"action_type\": \"ENCODE_CREDENTIAL\",\n# \"error\": null,\n# \"result\": {\n# \"access_method\": \"card\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n# \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n# \"errors\": [],\n# \"external_type\": \"visionline_card\",\n# \"external_type_display_name\": \"Visionline Card\",\n# \"is_issued\": true,\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"card_function_type\": \"guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"credential_id\": \"15\",\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"is_valid\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# },\n# \"status\": \"success\"\n# }" } ] } }, "/acs/encoders/get": { "get": { "description": "Returns a specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersGetGet", "parameters": [ { "in": "query", "name": "acs_encoder_id", "required": true, "schema": { "description": "ID of the encoder that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_encoder": { "$ref": "#/components/schemas/acs_encoder" }, "ok": { "type": "boolean" } }, "required": [ "acs_encoder", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/encoders/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "encoders" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_encoder", "x-response-key": "acs_encoder", "x-title": "Get an Encoder" }, "post": { "description": "Returns a specified [encoder](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_encoder_id": { "description": "ID of the encoder that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_encoder": { "$ref": "#/components/schemas/acs_encoder" } }, "required": [ "acs_encoder" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Encoder", "tags": [ "/acs" ], "x-response-key": "acs_encoder", "x-title": "Get an Encoder", "x-mint": { "href": "/api/acs/encoders/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.get({\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n});\n\n/*\n{\n \"acs_encoder_id\": \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n \"display_name\": \"Encoder 1\",\n \"errors\": [],\n \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->get(\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n);\n\n// [\n \"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders get --acs_encoder_id \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\"\n\n# {\n# \"acs_encoder_id\": \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n# \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n# \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n# \"display_name\": \"Encoder 1\",\n# \"errors\": [],\n# \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n# }" } ] } }, "/acs/encoders/list": { "get": { "description": "Returns a list of all [encoders](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersListGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_encoders": { "items": { "$ref": "#/components/schemas/acs_encoder" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_encoders", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/acs/encoders/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "encoders" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_encoders", "x-response-key": "acs_encoders", "x-title": "List Encoders" }, "post": { "description": "Returns a list of all [encoders](/low-level-apis/access-systems/working-with-card-encoders-and-scanners).", "operationId": "acsEncodersListPost", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to retrieve all encoders.", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id" ], "type": "object" }, { "properties": { "acs_system_ids": { "description": "IDs of the access systems for which you want to retrieve all encoders.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "acs_system_ids" ], "type": "object" }, { "properties": { "acs_encoder_ids": { "description": "IDs of the encoders that you want to retrieve.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "acs_encoder_ids" ], "type": "object" } ] }, { "properties": { "limit": { "default": 500, "description": "Number of encoders to return.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_encoders": { "items": { "$ref": "#/components/schemas/acs_encoder" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_encoders", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Encoders", "tags": [ "/acs" ], "x-response-key": "acs_encoders", "x-title": "List Encoders", "x-mint": { "href": "/api/acs/encoders/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.list();\n\n/*\n[\n {\n \"acs_encoder_id\": \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n \"display_name\": \"Encoder 1\",\n \"errors\": [],\n \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"acs_encoders\": [\n# {\n# \"acs_encoder_id\": \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n# \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n# \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n# \"display_name\": \"Encoder 1\",\n# \"errors\": [],\n# \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.acs.encoders.list()\n\n# [\n AcsEncoder(\n acs_encoder_id=\"681da2d6-4ac6-4b33-8c03-86281b761325\",\n acs_system_id=\"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n connected_account_id=\"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n created_at=\"2025-06-16T16:54:17.946527Z\",\n display_name=\"Encoder 1\",\n errors=[],\n workspace_id=\"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.acs.encoders.list()\n\n# => [\n {\n \"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->list();\n\n// [\n [\n \"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders list\n\n# [\n# {\n# \"acs_encoder_id\": \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n# \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n# \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n# \"display_name\": \"Encoder 1\",\n# \"errors\": [],\n# \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n# }\n# ]" } ] } }, "/acs/encoders/scan_credential": { "post": { "description": "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).", "operationId": "acsEncodersScanCredentialPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_encoder_id": { "description": "ID of the encoder to use for the scan.", "format": "uuid", "type": "string" }, "salto_ks_metadata": { "description": "Salto KS-specific metadata for the scan action.", "properties": { "detect_new_tags": { "default": false, "description": "When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.", "type": "boolean" } }, "type": "object" } }, "required": [ "acs_encoder_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SCAN_CREDENTIAL" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Scan a Credential", "tags": [ "/acs" ], "x-action-attempt-type": "SCAN_CREDENTIAL", "x-response-key": "action_attempt", "x-title": "Scan a Credential", "x-mint": { "href": "/api/acs/encoders/scan_credential" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.scanCredential({\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n});\n\n/*\n{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"action_type\": \"SCAN_CREDENTIAL\",\n \"error\": null,\n \"result\": {\n \"acs_credential_on_encoder\": {\n \"card_number\": \"164d29dc4a09b65f\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"ends_at\": \"2025-07-13T16:54:17.946512Z\",\n \"is_issued\": true,\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\": {\n \"cancelled\": false,\n \"card_format\": \"guest\",\n \"card_holder\": \"Guest\",\n \"card_id\": \"5\",\n \"common_acs_entrance_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n ],\n \"discarded\": false,\n \"expired\": false,\n \"guest_acs_entrance_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ],\n \"number_of_issued_cards\": 1,\n \"overridden\": false,\n \"overwritten\": false,\n \"pending_auto_update\": false\n }\n },\n \"acs_credential_on_seam\": {\n \"access_method\": \"card\",\n \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"card_number\": \"164d29dc4a09b65f\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n \"errors\": [],\n \"external_type\": \"visionline_card\",\n \"external_type_display_name\": \"Visionline Card\",\n \"is_issued\": true,\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": false,\n \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\": {\n \"card_function_type\": \"guest\",\n \"card_id\": \"5\",\n \"common_acs_entrance_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n ],\n \"credential_id\": \"15\",\n \"guest_acs_entrance_ids\": [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n ],\n \"is_valid\": true\n },\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n },\n \"warnings\": [\n {\n \"warning_code\": \"acs_credential_on_encoder_out_of_sync\",\n \"warning_message\": \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\"\n }\n ]\n },\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/scan_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"action_type\" => \"SCAN_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n acs_credential_on_encoder: {\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n ends_at: \"2025-07-13T16:54:17.946512Z\",\n is_issued: true,\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n cancelled: false,\n card_format: \"guest\",\n card_holder: \"Guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n discarded: false,\n expired: false,\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n number_of_issued_cards: 1,\n overridden: false,\n overwritten: false,\n pending_auto_update: false,\n },\n },\n acs_credential_on_seam: {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n warnings: [\n {\n warning_code: \"acs_credential_on_encoder_out_of_sync\",\n warning_message:\n \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\",\n },\n ],\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->scan_credential(\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n);\n\n// [\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"action_type\" => \"SCAN_CREDENTIAL\",\n \"error\" => null,\n \"result\" => [\n \"acs_credential_on_encoder\" => [\n \"card_number\" => \"164d29dc4a09b65f\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"ends_at\" => \"2025-07-13T16:54:17.946512Z\",\n \"is_issued\" => true,\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\" => [\n \"cancelled\" => false,\n \"card_format\" => \"guest\",\n \"card_holder\" => \"Guest\",\n \"card_id\" => \"5\",\n \"common_acs_entrance_ids\" => [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n ],\n \"discarded\" => false,\n \"expired\" => false,\n \"guest_acs_entrance_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n \"number_of_issued_cards\" => 1,\n \"overridden\" => false,\n \"overwritten\" => false,\n \"pending_auto_update\" => false,\n ],\n ],\n \"acs_credential_on_seam\" => [\n \"access_method\" => \"card\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"card_number\" => \"164d29dc4a09b65f\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Guest Lock 1, Vingcard Lock 2\",\n \"ends_at\" => \"2025-07-12T16:54:17.946512Z\",\n \"errors\" => [],\n \"external_type\" => \"visionline_card\",\n \"external_type_display_name\" => \"Visionline Card\",\n \"is_issued\" => true,\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"issued_at\" => \"2025-06-16T16:54:17.946512Z\",\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"visionline_metadata\" => [\n \"card_function_type\" => \"guest\",\n \"card_id\" => \"5\",\n \"common_acs_entrance_ids\" => [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n ],\n \"credential_id\" => \"15\",\n \"guest_acs_entrance_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n \"is_valid\" => true,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n ],\n \"warnings\" => [\n [\n \"warning_code\" => \"acs_credential_on_encoder_out_of_sync\",\n \"warning_message\" =>\n \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\",\n ],\n ],\n ],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders scan-credential --acs_encoder_id \"b062df92-91c6-482c-a3f9-6e578f062d36\"\n\n# {\n# \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n# \"action_type\": \"SCAN_CREDENTIAL\",\n# \"error\": null,\n# \"result\": {\n# \"acs_credential_on_encoder\": {\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"ends_at\": \"2025-07-13T16:54:17.946512Z\",\n# \"is_issued\": true,\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"cancelled\": false,\n# \"card_format\": \"guest\",\n# \"card_holder\": \"Guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"discarded\": false,\n# \"expired\": false,\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"number_of_issued_cards\": 1,\n# \"overridden\": false,\n# \"overwritten\": false,\n# \"pending_auto_update\": false\n# }\n# },\n# \"acs_credential_on_seam\": {\n# \"access_method\": \"card\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n# \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n# \"errors\": [],\n# \"external_type\": \"visionline_card\",\n# \"external_type_display_name\": \"Visionline Card\",\n# \"is_issued\": true,\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"card_function_type\": \"guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"credential_id\": \"15\",\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"is_valid\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# },\n# \"warnings\": [\n# {\n# \"warning_code\": \"acs_credential_on_encoder_out_of_sync\",\n# \"warning_message\": \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\"\n# }\n# ]\n# },\n# \"status\": \"success\"\n# }" } ] } }, "/acs/encoders/scan_to_assign_credential": { "post": { "description": "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`.", "operationId": "acsEncodersScanToAssignCredentialPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` to use to scan the credential.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the `acs_user` to assign the scanned credential to.", "format": "uuid", "type": "string" }, "salto_ks_metadata": { "description": "Salto KS-specific metadata for the scan action.", "properties": { "detect_new_tags": { "default": false, "description": "When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.", "type": "boolean" } }, "type": "object" }, "user_identity_id": { "description": "ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SCAN_TO_ASSIGN_CREDENTIAL" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Scan to Assign a Credential", "tags": [ "/acs" ], "x-action-attempt-type": "SCAN_TO_ASSIGN_CREDENTIAL", "x-response-key": "action_attempt", "x-title": "Scan to Assign a Credential", "x-mint": { "href": "/api/acs/encoders/scan_to_assign_credential" } } }, "/acs/encoders/simulate/next_credential_encode_will_fail": { "post": { "description": "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/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialEncodeWillFailPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": false, "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.", "format": "uuid", "type": "string" }, "error_code": { "default": "no_credential_on_encoder", "description": "Code of the error to simulate.", "enum": [ "no_credential_on_encoder", "encoding_interrupted" ], "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" }, { "additionalProperties": false, "properties": { "acs_credential_id": { "description": "ID of the `acs_credential` that will fail to be encoded onto a card in the next request.", "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.", "format": "uuid", "type": "string" }, "error_code": { "description": "Code of the error to simulate.", "enum": [ "uncategorized_error", "action_attempt_expired" ], "type": "string" } }, "required": [ "acs_encoder_id", "error_code" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate that the Next Credential Encoding Will Fail", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Simulate that the Next Credential Encoding Will Fail", "x-mint": { "href": "/api/acs/encoders/simulate/next_credential_encode_will_fail" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->simulate->next_credential_encode_will_fail(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders simulate next-credential-encode-will-fail --acs_encoder_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --error_code \"no_credential_on_encoder\"\n\n# {}" } ] } }, "/acs/encoders/simulate/next_credential_encode_will_succeed": { "post": { "description": "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-concepts/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialEncodeWillSucceedPost", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.", "format": "uuid", "type": "string" }, "scenario": { "default": "credential_is_issued", "description": "Scenario to simulate.", "enum": [ "credential_is_issued" ], "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate that the Next Credential Encoding Will Succeed", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Simulate that the Next Credential Encoding Will Succeed", "x-mint": { "href": "/api/acs/encoders/simulate/next_credential_encode_will_succeed" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->simulate->next_credential_encode_will_succeed(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders simulate next-credential-encode-will-succeed --acs_encoder_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --scenario \"credential_is_issued\"\n\n# {}" } ] } }, "/acs/encoders/simulate/next_credential_scan_will_fail": { "post": { "description": "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/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialScanWillFailPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": false, "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.", "format": "uuid", "type": "string" }, "error_code": { "default": "no_credential_on_encoder", "enum": [ "no_credential_on_encoder" ], "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" }, { "additionalProperties": false, "properties": { "acs_credential_id_on_seam": { "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.", "format": "uuid", "type": "string" }, "error_code": { "enum": [ "uncategorized_error", "action_attempt_expired" ], "type": "string" } }, "required": [ "acs_encoder_id", "error_code" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate that the Next Credential Scan Will Fail", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Simulate that the Next Credential Scan Will Fail", "x-mint": { "href": "/api/acs/encoders/simulate/next_credential_scan_will_fail" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->simulate->next_credential_scan_will_fail(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders simulate next-credential-scan-will-fail --acs_encoder_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --error_code \"no_credential_on_encoder\"\n\n# {}" } ] } }, "/acs/encoders/simulate/next_credential_scan_will_succeed": { "post": { "description": "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/workspaces#sandbox-workspaces).", "operationId": "acsEncodersSimulateNextCredentialScanWillSucceedPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": false, "properties": { "acs_credential_id_on_seam": { "description": "ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.", "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.", "format": "uuid", "type": "string" }, "scenario": { "default": "credential_exists_on_seam", "description": "Scenario to simulate.", "enum": [ "credential_exists_on_seam", "credential_on_encoder_needs_update" ], "type": "string" } }, "required": [ "acs_encoder_id" ], "type": "object" }, { "additionalProperties": false, "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.", "format": "uuid", "type": "string" }, "scenario": { "description": "Scenario to simulate.", "enum": [ "credential_does_not_exist_on_seam" ], "type": "string" } }, "required": [ "acs_encoder_id", "scenario" ], "type": "object" }, { "additionalProperties": false, "properties": { "acs_encoder_id": { "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.", "format": "uuid", "type": "string" }, "scenario": { "description": "Scenario to simulate.", "enum": [ "credential_on_encoder_is_empty" ], "type": "string" } }, "required": [ "acs_encoder_id", "scenario" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate that the Next Credential Scan Will Succeed", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Simulate that the Next Credential Scan Will Succeed", "x-mint": { "href": "/api/acs/encoders/simulate/next_credential_scan_will_succeed" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_exists_on_seam\",\n acs_credential_id_on_seam: \"123e4567-e89b-12d3-a456-426614174000\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->encoders->simulate->next_credential_scan_will_succeed(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_exists_on_seam\",\n acs_credential_id_on_seam: \"123e4567-e89b-12d3-a456-426614174000\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs encoders simulate next-credential-scan-will-succeed --acs_encoder_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --scenario \"credential_exists_on_seam\" --acs_credential_id_on_seam \"123e4567-e89b-12d3-a456-426614174000\"\n\n# {}" } ] } }, "/acs/entrances/get": { "get": { "description": "Returns a specified [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesGetGet", "parameters": [ { "in": "query", "name": "acs_entrance_id", "required": true, "schema": { "description": "ID of the entrance that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrance": { "$ref": "#/components/schemas/acs_entrance" }, "ok": { "type": "boolean" } }, "required": [ "acs_entrance", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "client_session": [] } ], "summary": "/acs/entrances/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "entrances" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_entrance", "x-response-key": "acs_entrance", "x-title": "Get an Entrance" }, "post": { "description": "Returns a specified [access system entrance](/low-level-apis/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_id": { "description": "ID of the entrance that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrance": { "$ref": "#/components/schemas/acs_entrance" } }, "required": [ "acs_entrance" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "client_session": [] } ], "summary": "Get an Entrance", "tags": [ "/acs" ], "x-response-key": "acs_entrance", "x-title": "Get an Entrance", "x-mint": { "href": "/api/acs/entrances/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.entrances.get({\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n});\n\n/*\n{\n \"acs_entrance_id\": \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n \"display_name\": \"Main Entrance\",\n \"errors\": [],\n \"visionline_metadata\": {\n \"door_category\": \"guest\",\n \"door_name\": \"Main Entrance\",\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ]\n }\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->entrances->get(\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n);\n\n// [\n \"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => [\n \"door_category\" => \"guest\",\n \"door_name\" => \"Main Entrance\",\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs entrances get --acs_entrance_id \"c931c953-4a5b-4f66-9189-500d39959ad1\"\n\n# {\n# \"acs_entrance_id\": \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }" } ] } }, "/acs/entrances/grant_access": { "post": { "description": "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).", "operationId": "acsEntrancesGrantAccessPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_id": { "description": "ID of the entrance to which you want to grant an access system user access.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", "format": "uuid", "type": "string" } }, "required": [ "acs_entrance_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Grant an ACS User Access to an Entrance", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Grant an ACS User Access to an Entrance", "x-mint": { "href": "/api/acs/entrances/grant_access" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.entrances.grantAccess({\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->entrances->grant_access(\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs entrances grant-access --acs_entrance_id \"d23d7180-c1ee-4bbe-8630-05df5031ce35\" --user_identity_id \"c6247b75-f1cb-493a-9915-a85a0b9639ae\"\n\n# {}" } ] } }, "/acs/entrances/list": { "get": { "description": "Returns a list of all [access system entrances](/low-level-apis/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list entrances.", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system for which you want to retrieve all entrances.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_credential_id", "schema": { "description": "ID of the credential for which you want to retrieve all entrances.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list entrances.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to retrieve all entrances.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_ids", "schema": { "description": "IDs of the entrances for which you want to retrieve all entrances.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 900, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_entrances", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/acs/entrances/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "entrances" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_entrances", "x-response-key": "acs_entrances", "x-title": "List Entrances" }, "post": { "description": "Returns a list of all [access system entrances](/low-level-apis/access-systems/retrieving-entrance-details).", "operationId": "acsEntrancesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the credential for which you want to retrieve all entrances.", "format": "uuid", "type": "string" }, "acs_entrance_ids": { "description": "IDs of the entrances for which you want to retrieve all entrances.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "acs_system_id": { "description": "ID of the access system for which you want to retrieve all entrances.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to retrieve all entrances.", "format": "uuid", "type": "string" }, "customer_key": { "description": "Customer key for which you want to list entrances.", "type": "string" }, "limit": { "default": 900, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list entrances.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_entrances", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "List Entrances", "tags": [ "/acs" ], "x-response-key": "acs_entrances", "x-title": "List Entrances", "x-mint": { "href": "/api/acs/entrances/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.entrances.list({\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n});\n\n/*\n[\n {\n \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\": \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n \"display_name\": \"Main Entrance\",\n \"errors\": [],\n \"visionline_metadata\": {\n \"door_category\": \"guest\",\n \"door_name\": \"Main Entrance\",\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ]\n }\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->entrances->list(\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n);\n\n// [\n [\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => [\n \"door_category\" => \"guest\",\n \"door_name\" => \"Main Entrance\",\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs entrances list --acs_system_id \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\"\n\n# [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]" } ] } }, "/acs/entrances/list_credentials_with_access": { "get": { "description": "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).", "operationId": "acsEntrancesListCredentialsWithAccessGet", "parameters": [ { "in": "query", "name": "acs_entrance_id", "required": true, "schema": { "description": "ID of the entrance for which you want to list all credentials that grant access.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "include_if", "required": false, "schema": { "description": "Conditions that credentials must meet to be included in the returned list.", "items": { "enum": [ "visionline_metadata.is_valid" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_credentials", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/entrances/list_credentials_with_access", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "entrances" ], "x-fern-sdk-method-name": "list_credentials_with_access", "x-fern-sdk-return-value": "acs_credentials", "x-response-key": "acs_credentials", "x-title": "List Credentials with Access to an Entrance" }, "post": { "description": "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).", "operationId": "acsEntrancesListCredentialsWithAccessPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_id": { "description": "ID of the entrance for which you want to list all credentials that grant access.", "format": "uuid", "type": "string" }, "include_if": { "description": "Conditions that credentials must meet to be included in the returned list.", "items": { "enum": [ "visionline_metadata.is_valid" ], "type": "string" }, "type": "array" } }, "required": [ "acs_entrance_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_credentials": { "items": { "$ref": "#/components/schemas/acs_credential" }, "type": "array" } }, "required": [ "acs_credentials" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Credentials with Access to an Entrance", "tags": [ "/acs" ], "x-response-key": "acs_credentials", "x-title": "List Credentials with Access to an Entrance", "x-mint": { "href": "/api/acs/entrances/list_credentials_with_access" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.entrances.listCredentialsWithAccess({\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n});\n\n/*\n[\n {\n \"access_method\": \"code\",\n \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\": \"123456\",\n \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n \"display_name\": \"FRONT_DOOR\",\n \"errors\": [],\n \"external_type\": \"salto_ks_credential\",\n \"external_type_display_name\": \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\": true,\n \"is_managed\": true,\n \"is_multi_phone_sync_credential\": false,\n \"is_one_time_use\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n \"warnings\": [],\n \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list_credentials_with_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->entrances->list_credentials_with_access(\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n);\n\n// [\n [\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs entrances list-credentials-with-access --acs_entrance_id \"afdde789-8684-425a-b421-6031bb3df62e\"\n\n# [\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"code\": \"123456\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"FRONT_DOOR\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }\n# ]" } ] } }, "/acs/entrances/unlock": { "post": { "description": "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.", "operationId": "acsEntrancesUnlockPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the cloud_key credential to use for the unlock operation.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the entrance to unlock.", "format": "uuid", "type": "string" } }, "required": [ "acs_entrance_id", "acs_credential_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "UNLOCK_DOOR" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Unlock an Entrance", "tags": [ "/acs" ], "x-action-attempt-type": "UNLOCK_DOOR", "x-response-key": "action_attempt", "x-title": "Unlock an Entrance", "x-mint": { "href": "/api/acs/entrances/unlock" } } }, "/acs/systems/get": { "get": { "description": "Returns a specified [access system](/low-level-apis/access-systems).", "operationId": "acsSystemsGetGet", "parameters": [ { "in": "query", "name": "acs_system_id", "required": true, "schema": { "description": "ID of the access system that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_system": { "$ref": "#/components/schemas/acs_system" }, "ok": { "type": "boolean" } }, "required": [ "acs_system", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/systems/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "systems" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_system", "x-response-key": "acs_system", "x-title": "Get an ACS System" }, "post": { "description": "Returns a specified [access system](/low-level-apis/access-systems).", "operationId": "acsSystemsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_system": { "$ref": "#/components/schemas/acs_system" } }, "required": [ "acs_system" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an ACS System", "tags": [ "/acs" ], "x-response-key": "acs_system", "x-title": "Get an ACS System", "x-mint": { "href": "/api/acs/systems/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.systems.get({\n acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n});\n\n/*\n{\n \"acs_access_group_count\": 5,\n \"acs_system_id\": \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n \"acs_user_count\": 20,\n \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\": [\n \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\": [],\n \"external_type\": \"salto_ks_site\",\n \"external_type_display_name\": \"Salto KS site\",\n \"image_alt_text\": \"Salto KS site Logo\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\": false,\n \"location\": {\n \"time_zone\": \"America/New_York\"\n },\n \"name\": \"My Access System\",\n \"warnings\": [],\n \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->systems->get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\");\n\n// [\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" =>\n \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs systems get --acs_system_id \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\"\n\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }" } ] } }, "/acs/systems/list": { "get": { "description": "Returns a list of all [access systems](/low-level-apis/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.", "operationId": "acsSystemsListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list access systems.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account by which you want to filter the list of access systems.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_systems", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "summary": "/acs/systems/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "systems" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_systems", "x-response-key": "acs_systems", "x-title": "List ACS Systems" }, "post": { "description": "Returns a list of all [access systems](/low-level-apis/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.", "operationId": "acsSystemsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account by which you want to filter the list of access systems.", "format": "uuid", "type": "string" }, "customer_key": { "description": "Customer key for which you want to list access systems.", "type": "string" }, "search": { "description": "String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`.", "minLength": 1, "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" } }, "required": [ "acs_systems" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "summary": "List ACS Systems", "tags": [ "/acs" ], "x-response-key": "acs_systems", "x-title": "List ACS Systems", "x-mint": { "href": "/api/acs/systems/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.systems.list({\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n});\n\n/*\n[\n {\n \"acs_access_group_count\": 5,\n \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\": 20,\n \"connected_account_id\": \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n \"connected_account_ids\": [\n \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\": [],\n \"external_type\": \"salto_ks_site\",\n \"external_type_display_name\": \"Salto KS site\",\n \"image_alt_text\": \"Salto KS site Logo\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\": false,\n \"location\": {\n \"time_zone\": \"America/New_York\"\n },\n \"name\": \"My Access System\",\n \"warnings\": [],\n \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->systems->list(\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n);\n\n// [\n [\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" =>\n \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs systems list --connected_account_id \"2283a842-27c5-474a-bd0e-4c959274efa0\"\n\n# [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]" } ] } }, "/acs/systems/list_compatible_credential_manager_acs_systems": { "get": { "description": "Returns a list of all credential manager systems that are compatible with a specified [access system](/low-level-apis/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.", "operationId": "acsSystemsListCompatibleCredentialManagerAcsSystemsGet", "parameters": [ { "in": "query", "name": "acs_system_id", "required": true, "schema": { "description": "ID of the access system for which you want to retrieve all compatible credential manager systems.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_systems", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/systems/list_compatible_credential_manager_acs_systems", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "systems" ], "x-fern-sdk-method-name": "list_compatible_credential_manager_acs_systems", "x-fern-sdk-return-value": "acs_systems", "x-response-key": "acs_systems", "x-title": "List Compatible Credential Manager ACS Systems" }, "post": { "description": "Returns a list of all credential manager systems that are compatible with a specified [access system](/low-level-apis/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.", "operationId": "acsSystemsListCompatibleCredentialManagerAcsSystemsPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to retrieve all compatible credential manager systems.", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" } }, "required": [ "acs_systems" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Compatible Credential Manager ACS Systems", "tags": [ "/acs" ], "x-response-key": "acs_systems", "x-title": "List Compatible Credential Manager ACS Systems", "x-mint": { "href": "/api/acs/systems/list_compatible_credential_manager_acs_systems" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n});\n\n/*\n[\n {\n \"acs_access_group_count\": 5,\n \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\": [\n \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n \"errors\": [],\n \"image_alt_text\": \"Salto KS site Logo\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\": true,\n \"location\": {\n \"time_zone\": \"America/New_York\"\n },\n \"name\": \"My Credential Manager\",\n \"warnings\": [],\n \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list_compatible_credential_manager_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"errors\" => [],\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => true,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->systems->list_compatible_credential_manager_acs_systems(\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n);\n\n// [\n [\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"errors\" => [],\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => true,\n \"location\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id \"82456f4c-9627-4a27-a426-1b3c50c9871b\"\n\n# [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"errors\": [],\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": true,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Credential Manager\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]" } ] } }, "/acs/systems/report_devices": { "post": { "description": "Reports ACS system device status including encoders and entrances.", "operationId": "acsSystemsReportDevicesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_encoders": { "default": [], "description": "Array of ACS encoders to report", "items": { "properties": { "hotek_metadata": { "description": "Hotek-specific metadata associated with the entrance.", "properties": { "encoder_number": { "description": "The encoder number determined by the USB port connection.", "type": "string" } }, "required": [ "encoder_number" ], "type": "object" }, "is_removed": { "default": false, "description": "Whether the encoder is removed", "type": "boolean" } }, "required": [ "hotek_metadata" ], "type": "object" }, "type": "array" }, "acs_entrances": { "default": [], "description": "Array of ACS entrances to report", "items": { "properties": { "hotek_metadata": { "description": "Hotek-specific metadata associated with the entrance.", "properties": { "common_area_name": { "description": "The common area name", "type": "string" }, "common_area_number": { "description": "The room number identifier", "type": "string" }, "room_number": { "description": "The room number identifier", "type": "string" } }, "type": "object" }, "is_removed": { "default": false, "description": "Whether the entrance is removed", "type": "boolean" } }, "required": [ "hotek_metadata" ], "type": "object" }, "type": "array" }, "acs_system_id": { "description": "ID of the ACS system to report resources for", "format": "uuid", "type": "string" } }, "required": [ "acs_system_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Report Devices", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Report Devices", "x-mint": { "href": "/api/acs/systems/report_devices" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.systems.reportDevices({\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n { hotek_metadata: { encoder_number: \"1\" } },\n { is_removed: true, hotek_metadata: { encoder_number: \"2\" } },\n ],\n acs_entrances: [\n { hotek_metadata: { room_number: \"203\" } },\n { is_removed: true, hotek_metadata: { room_number: \"500\" } },\n { hotek_metadata: { common_area_name: \"Gym\", common_area_number: \"2\" } },\n ],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/report_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->systems->report_devices(\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n [\"hotek_metadata\" => [\"encoder_number\" => \"1\"]],\n [\"is_removed\" => true, \"hotek_metadata\" => [\"encoder_number\" => \"2\"]],\n ],\n acs_entrances: [\n [\"hotek_metadata\" => [\"room_number\" => \"203\"]],\n [\"is_removed\" => true, \"hotek_metadata\" => [\"room_number\" => \"500\"]],\n [\n \"hotek_metadata\" => [\n \"common_area_name\" => \"Gym\",\n \"common_area_number\" => \"2\",\n ],\n ],\n ],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs systems report-devices --acs_system_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --acs_encoders [{\"hotek_metadata\":{\"encoder_number\":\"1\"}},{\"is_removed\":true,\"hotek_metadata\":{\"encoder_number\":\"2\"}}] --acs_entrances [{\"hotek_metadata\":{\"room_number\":\"203\"}},{\"is_removed\":true,\"hotek_metadata\":{\"room_number\":\"500\"}},{\"hotek_metadata\":{\"common_area_name\":\"Gym\",\"common_area_number\":\"2\"}}]\n\n# {}" } ] } }, "/acs/users/add_to_access_group": { "post": { "description": "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).", "operationId": "acsUsersAddToAccessGroupPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group to which you want to add an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to add to an access group.", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id", "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Add an ACS User to an Access Group", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Add an ACS User to an Access Group", "x-mint": { "href": "/api/acs/users/add_to_access_group" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.addToAccessGroup({\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/add_to_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->add_to_access_group(\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users add-to-access-group --acs_user_id \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\" --acs_access_group_id \"58c8b034-e527-4635-a335-afc74dc79b27\"\n\n# {}" } ] }, "put": { "description": "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).", "operationId": "acsUsersAddToAccessGroupPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group to which you want to add an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to add to an access group.", "format": "uuid", "type": "string" } }, "required": [ "acs_user_id", "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/add_to_access_group", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "add_to_access_group", "x-response-key": null, "x-title": "Add an ACS User to an Access Group" } }, "/acs/users/create": { "post": { "description": "Creates a new [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.", "properties": { "ends_at": { "description": "Ending timestamp for the new access system user's access.", "format": "date-time", "nullable": true, "type": "string" }, "starts_at": { "description": "Starting timestamp for the new access system user's access.", "format": "date-time", "type": "string" } }, "type": "object" }, "acs_access_group_ids": { "default": [], "description": "Array of access group IDs to indicate the access groups to which you want to add the new access system user.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "acs_system_id": { "description": "ID of the access system to which you want to add the new access system user.", "format": "uuid", "type": "string" }, "email": { "deprecated": true, "format": "email", "type": "string", "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", "format": "email", "type": "string" }, "full_name": { "description": "Full name of the new access system user.", "type": "string" }, "phone_number": { "description": "Phone number of the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "type": "string" }, "user_identity_id": { "description": "ID of the user identity with which you want to associate the new access system user.", "format": "uuid", "type": "string" } }, "required": [ "full_name", "acs_system_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" } }, "required": [ "acs_user" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create an ACS User", "tags": [ "/acs" ], "x-response-key": "acs_user", "x-title": "Create an ACS User", "x-mint": { "href": "/api/acs/users/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.create({\n full_name: \"Jane Doe\",\n acs_system_id: \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n acs_access_group_ids: [\"bab9962b-708b-4db7-98d5-b242a28c12e9\"],\n user_identity_id: \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n access_schedule: {\n starts_at: \"2025-06-10T15:00:00.000Z\",\n ends_at: \"2025-06-12T11:00:00.000Z\",\n },\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n});\n\n/*\n{\n \"access_schedule\": {\n \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n },\n \"acs_system_id\": \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"external_type\": \"salto_site_user\",\n \"external_type_display_name\": \"Salto site user\",\n \"full_name\": \"Jane Doe\",\n \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\": true,\n \"is_suspended\": false,\n \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\": [],\n \"phone_number\": \"+15551234567\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_id\": \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"user_identity_phone_number\": \"+15551234567\",\n \"warnings\": [],\n \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+15551234567\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"user_identity_phone_number\" => \"+15551234567\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->create(\n full_name: \"Jane Doe\",\n acs_system_id: \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n acs_access_group_ids: [\"bab9962b-708b-4db7-98d5-b242a28c12e9\"],\n user_identity_id: \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n access_schedule: [\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n ],\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n);\n\n// [\n \"access_schedule\" => [\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n ],\n \"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+15551234567\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"user_identity_phone_number\" => \"+15551234567\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users create --full_name \"Jane Doe\" --acs_system_id \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\" --acs_access_group_ids [\"bab9962b-708b-4db7-98d5-b242a28c12e9\"] --user_identity_id \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\" --access_schedule {\"starts_at\":\"2025-06-10T15:00:00.000Z\",\"ends_at\":\"2025-06-12T11:00:00.000Z\"} --email_address \"jane@example.com\" --phone_number \"+15551234567\"\n\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+15551234567\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n# \"user_identity_phone_number\": \"+15551234567\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }" } ] } }, "/acs/users/delete": { "delete": { "description": "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).", "operationId": "acsUsersDeleteDelete", "parameters": [ { "in": "query", "name": "acs_user_id", "schema": { "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/delete", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an ACS User" }, "post": { "description": "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).", "operationId": "acsUsersDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Delete an ACS User", "x-mint": { "href": "/api/acs/users/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.delete({\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->delete(\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users delete --user_identity_id \"586c225c-b05c-4af4-8679-9c8a46066cce\" --acs_system_id \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\"\n\n# {}" } ] } }, "/acs/users/get": { "get": { "description": "Returns a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersGetGet", "parameters": [ { "in": "query", "name": "acs_user_id", "schema": { "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" }, "ok": { "type": "boolean" } }, "required": [ "acs_user", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/get", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "acs_user", "x-response-key": "acs_user", "x-title": "Get an ACS User" }, "post": { "description": "Returns a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_user": { "$ref": "#/components/schemas/acs_user" } }, "required": [ "acs_user" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an ACS User", "tags": [ "/acs" ], "x-response-key": "acs_user", "x-title": "Get an ACS User", "x-mint": { "href": "/api/acs/users/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.get({\n user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n});\n\n/*\n{\n \"access_schedule\": {\n \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n },\n \"acs_system_id\": \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n \"acs_user_id\": \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"external_type\": \"salto_site_user\",\n \"external_type_display_name\": \"Salto site user\",\n \"full_name\": \"Jane Doe\",\n \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\": true,\n \"is_suspended\": false,\n \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\": [],\n \"phone_number\": \"+1555551000\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_id\": \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"user_identity_phone_number\": \"+1555551000\",\n \"warnings\": [],\n \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n \"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->get(\n user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n);\n\n// [\n \"access_schedule\" => [\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n ],\n \"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n \"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users get --user_identity_id \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\" --acs_system_id \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\"\n\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n# \"acs_user_id\": \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }" } ] } }, "/acs/users/list": { "get": { "description": "Returns a list of all [access system users](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersListGet", "parameters": [ { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_phone_number", "schema": { "description": "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).", "type": "string" } }, { "in": "query", "name": "user_identity_email_address", "schema": { "description": "Email address of the user identity for which you want to retrieve all access system users.", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the `acs_system` for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned access system users. Returns users created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_users", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/list", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "acs_users", "x-response-key": "acs_users", "x-title": "List ACS Users" }, "post": { "description": "Returns a list of all [access system users](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the `acs_system` for which you want to retrieve all access system users.", "format": "uuid", "type": "string" }, "created_before": { "description": "Timestamp by which to limit returned access system users. Returns users created before this timestamp.", "format": "date-time", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.", "minLength": 1, "type": "string" }, "user_identity_email_address": { "description": "Email address of the user identity for which you want to retrieve all access system users.", "type": "string" }, "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all access system users.", "format": "uuid", "type": "string" }, "user_identity_phone_number": { "description": "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "acs_users", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List ACS Users", "tags": [ "/acs" ], "x-response-key": "acs_users", "x-title": "List ACS Users", "x-mint": { "href": "/api/acs/users/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.list({\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n});\n\n/*\n[\n {\n \"access_schedule\": {\n \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n },\n \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"external_type\": \"salto_site_user\",\n \"external_type_display_name\": \"Salto site user\",\n \"full_name\": \"Jane Doe\",\n \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\": true,\n \"is_suspended\": false,\n \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\": [],\n \"phone_number\": \"+1555551000\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_id\": \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n \"user_identity_phone_number\": \"+1555551000\",\n \"warnings\": [],\n \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->list(\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n);\n\n// [\n [\n \"access_schedule\" => [\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n ],\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users list --user_identity_id \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\"\n\n# [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]" } ] } }, "/acs/users/list_accessible_entrances": { "get": { "description": "Lists the [entrances](/api/acs/entrances/object) to which a specified [access system user](/low-level-apis/access-systems/user-management) has access.", "operationId": "acsUsersListAccessibleEntrancesGet", "parameters": [ { "in": "query", "name": "acs_user_id", "schema": { "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_entrances", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/list_accessible_entrances", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances", "x-response-key": "acs_entrances", "x-title": "List ACS User-Accessible Entrances" }, "post": { "description": "Lists the [entrances](/api/acs/entrances/object) to which a specified [access system user](/low-level-apis/access-systems/user-management) has access.", "operationId": "acsUsersListAccessibleEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" } }, "required": [ "acs_entrances" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List ACS User-Accessible Entrances", "tags": [ "/acs" ], "x-response-key": "acs_entrances", "x-title": "List ACS User-Accessible Entrances", "x-mint": { "href": "/api/acs/users/list_accessible_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.listAccessibleEntrances({\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n});\n\n/*\n[\n {\n \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n \"display_name\": \"Main Entrance\",\n \"errors\": [],\n \"visionline_metadata\": {\n \"door_category\": \"guest\",\n \"door_name\": \"Main Entrance\",\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ]\n }\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->list_accessible_entrances(\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n);\n\n// [\n [\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => [\n \"door_category\" => \"guest\",\n \"door_name\" => \"Main Entrance\",\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users list-accessible-entrances --user_identity_id \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\" --acs_system_id \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\"\n\n# [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]" } ] } }, "/acs/users/remove_from_access_group": { "delete": { "description": "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).", "operationId": "acsUsersRemoveFromAccessGroupDelete", "parameters": [ { "in": "query", "name": "acs_user_id", "required": false, "schema": { "description": "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "required": false, "schema": { "description": "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_access_group_id", "required": true, "schema": { "description": "ID of the access group from which you want to remove an access system user.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/acs/users/remove_from_access_group", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "remove_from_access_group", "x-response-key": null, "x-title": "Remove an ACS User from an Access Group" }, "post": { "description": "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).", "operationId": "acsUsersRemoveFromAccessGroupPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_access_group_id": { "description": "ID of the access group from which you want to remove an access system user.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "required": [ "acs_access_group_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Remove an ACS User from an Access Group", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Remove an ACS User from an Access Group", "x-mint": { "href": "/api/acs/users/remove_from_access_group" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.removeFromAccessGroup({\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/remove_from_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->remove_from_access_group(\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users remove-from-access-group --user_identity_id \"00ff2781-cce8-4b63-8c65-2b97647d790c\" --acs_access_group_id \"d192f395-4c68-4c33-af41-97a7df5be576\"\n\n# {}" } ] } }, "/acs/users/revoke_access_to_all_entrances": { "post": { "description": "Revokes access to all [entrances](/api/acs/entrances/object) for a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersRevokeAccessToAllEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Revoke ACS User Access to All Entrances", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Revoke ACS User Access to All Entrances", "x-mint": { "href": "/api/acs/users/revoke_access_to_all_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.revokeAccessToAllEntrances({\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/revoke_access_to_all_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->revoke_access_to_all_entrances(\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users revoke-access-to-all-entrances --user_identity_id \"aadb341e-6cd5-4c8b-9561-8f686f84160c\" --acs_system_id \"d42163f1-ac2d-4c15-a651-5f2e0007b297\"\n\n# {}" } ] } }, "/acs/users/suspend": { "post": { "description": "[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 access, you can [unsuspend](/api/acs/users/unsuspend) them.", "operationId": "acsUsersSuspendPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Suspend an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Suspend an ACS User", "x-mint": { "href": "/api/acs/users/suspend" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.suspend({\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/suspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->suspend(\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users suspend --user_identity_id \"73fac667-bd93-4548-add2-e75161d69c7c\" --acs_system_id \"f2240088-0bc7-4edb-80d1-485bd956ba7d\"\n\n# {}" } ] } }, "/acs/users/unsuspend": { "post": { "description": "[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 temporarily, unsuspending the access system user restores their access.", "operationId": "acsUsersUnsuspendPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_id": { "description": "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Unsuspend an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Unsuspend an ACS User", "x-mint": { "href": "/api/acs/users/unsuspend" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.unsuspend({\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/unsuspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->unsuspend(\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users unsuspend --user_identity_id \"6a42fbcf-da1a-40f8-8221-596774f97537\" --acs_system_id \"264ea3f9-e483-469e-aada-c98c094d5521\"\n\n# {}" } ] } }, "/acs/users/update": { "patch": { "description": "Updates the properties of a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.", "nullable": true, "properties": { "ends_at": { "description": "Ending timestamp for the access system user's access.", "format": "date-time", "type": "string" }, "starts_at": { "description": "Starting timestamp for the access system user's access.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_system_id": { "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "email": { "deprecated": true, "format": "email", "type": "string", "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", "format": "email", "type": "string" }, "full_name": { "description": "Full name of the [access system user](/low-level-apis/access-systems/user-management).", "minLength": 1, "type": "string" }, "hid_acs_system_id": { "description": "ID of the HID access control system associated with the user.", "format": "uuid", "type": "string" }, "phone_number": { "description": "Phone number of the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/acs/users/update", "tags": [ "/acs" ], "x-fern-sdk-group-name": [ "acs", "users" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an ACS User" }, "post": { "description": "Updates the properties of a specified [access system user](/low-level-apis/access-systems/user-management).", "operationId": "acsUsersUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.", "nullable": true, "properties": { "ends_at": { "description": "Ending timestamp for the access system user's access.", "format": "date-time", "type": "string" }, "starts_at": { "description": "Starting timestamp for the access system user's access.", "format": "date-time", "type": "string" } }, "required": [ "starts_at", "ends_at" ], "type": "object" }, "acs_system_id": { "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.", "format": "uuid", "type": "string" }, "email": { "deprecated": true, "format": "email", "type": "string", "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", "format": "email", "type": "string" }, "full_name": { "description": "Full name of the [access system user](/low-level-apis/access-systems/user-management).", "minLength": 1, "type": "string" }, "hid_acs_system_id": { "description": "ID of the HID access control system associated with the user.", "format": "uuid", "type": "string" }, "phone_number": { "description": "Phone number of the [access system user](/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Update an ACS User", "tags": [ "/acs" ], "x-response-key": null, "x-title": "Update an ACS User", "x-mint": { "href": "/api/acs/users/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.acs.users.update({\n acs_user_id: \"5db87499-0b3b-4750-a2e8-341b2af64049\",\n user_identity_id: \"b0bbb463-4fad-4b21-a695-952463ea6e93\",\n acs_system_id: \"88ae7b8b-c406-414b-a745-91d9cea661f7\",\n access_schedule: {\n starts_at: \"2025-06-10T15:00:00.000Z\",\n ends_at: \"2025-06-12T11:00:00.000Z\",\n },\n full_name: \"Jane Doe\",\n email: \"jane@example.com\",\n phone_number: \"+15551234567\",\n email_address: \"jane@example.com\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->acs->users->update(\n acs_user_id: \"5db87499-0b3b-4750-a2e8-341b2af64049\",\n user_identity_id: \"b0bbb463-4fad-4b21-a695-952463ea6e93\",\n acs_system_id: \"88ae7b8b-c406-414b-a745-91d9cea661f7\",\n access_schedule: [\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n ],\n full_name: \"Jane Doe\",\n email: \"jane@example.com\",\n phone_number: \"+15551234567\",\n email_address: \"jane@example.com\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam acs users update --acs_user_id \"5db87499-0b3b-4750-a2e8-341b2af64049\" --user_identity_id \"b0bbb463-4fad-4b21-a695-952463ea6e93\" --acs_system_id \"88ae7b8b-c406-414b-a745-91d9cea661f7\" --access_schedule {\"starts_at\":\"2025-06-10T15:00:00.000Z\",\"ends_at\":\"2025-06-12T11:00:00.000Z\"} --full_name \"Jane Doe\" --email \"jane@example.com\" --phone_number \"+15551234567\" --email_address \"jane@example.com\"\n\n# {}" } ] } }, "/action_attempts/get": { "get": { "description": "Returns a specified [action attempt](/core-concepts/action-attempts).", "operationId": "actionAttemptsGetGet", "parameters": [ { "in": "query", "name": "action_attempt_id", "required": true, "schema": { "description": "ID of the action attempt that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/action_attempts/get", "tags": [ "/action_attempts" ], "x-fern-sdk-group-name": [ "action_attempts" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "action_attempt", "x-response-key": "action_attempt", "x-title": "Get an Action Attempt" }, "post": { "description": "Returns a specified [action attempt](/core-concepts/action-attempts).", "operationId": "actionAttemptsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action_attempt_id": { "description": "ID of the action attempt that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "action_attempt_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get an Action Attempt", "tags": [ "/action_attempts" ], "x-response-key": "action_attempt", "x-title": "Get an Action Attempt", "x-mint": { "href": "/api/action_attempts/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.actionAttempts.get({\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n});\n\n/*\n{\n \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\": \"UNLOCK_DOOR\",\n \"error\": null,\n \"result\": {\n \"was_confirmed_by_device\": false\n },\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->action_attempts->get(\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n);\n\n// [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam action-attempts get --action_attempt_id \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n\n# {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# }" } ] } }, "/action_attempts/list": { "get": { "description": "Returns a list of the [action attempts](/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.", "operationId": "actionAttemptsListGet", "parameters": [ { "in": "query", "name": "action_attempt_ids", "schema": { "description": "IDs of the action attempts that you want to retrieve.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "device_id", "schema": { "description": "ID of the device to filter action attempts by.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempts": { "items": { "$ref": "#/components/schemas/action_attempt" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "action_attempts", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/action_attempts/list", "tags": [ "/action_attempts" ], "x-fern-sdk-group-name": [ "action_attempts" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "action_attempts", "x-response-key": "action_attempts", "x-title": "List Action Attempts" }, "post": { "description": "Returns a list of the [action attempts](/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.", "operationId": "actionAttemptsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action_attempt_ids": { "description": "IDs of the action attempts that you want to retrieve.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_id": { "description": "ID of the device to filter action attempts by.", "format": "uuid", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempts": { "items": { "$ref": "#/components/schemas/action_attempt" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "action_attempts", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Action Attempts", "tags": [ "/action_attempts" ], "x-response-key": "action_attempts", "x-title": "List Action Attempts", "x-mint": { "href": "/api/action_attempts/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.actionAttempts.list({\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n});\n\n/*\n[\n {\n \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\": \"UNLOCK_DOOR\",\n \"error\": null,\n \"result\": {\n \"was_confirmed_by_device\": false\n },\n \"status\": \"success\"\n },\n {\n \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\": \"LOCK_DOOR\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n },\n {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->action_attempts->list(\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n);\n\n// [\n [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n ],\n [\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam action-attempts list --action_attempt_ids [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"]\n\n# [\n# {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# },\n# {\n# \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n# \"action_type\": \"LOCK_DOOR\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# ]" } ] } }, "/client_sessions/create": { "post": { "description": "Creates a new [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) for which you want to create a client session.", "items": { "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) for which you want to create a client session.", "items": { "type": "string" }, "type": "array" }, "customer_id": { "description": "Customer ID that you want to associate with the new client session.", "type": "string" }, "customer_key": { "description": "Customer key that you want to associate with the new client session.", "minLength": 1, "type": "string" }, "expires_at": { "description": "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user for whom you want to create a client session.", "minLength": 1, "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.", "format": "uuid", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" } }, "required": [ "client_session" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Create a Client Session", "tags": [ "/client_sessions" ], "x-response-key": "client_session", "x-title": "Create a Client Session", "x-mint": { "href": "/api/client_sessions/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.create({\n customer_id: \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n customer_key: \"My Company\",\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n connected_account_ids: [\"8062d457-e28e-481f-aecc-509905627511\"],\n user_identity_id: \"89765fd3-6193-4d63-8605-e77f75356555\",\n expires_at: \"2025-06-19T15:22:40.000Z\",\n});\n\n/*\n{\n \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\": [\n \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n ],\n \"connected_account_ids\": [\n \"8062d457-e28e-481f-aecc-509905627511\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\": 1,\n \"expires_at\": \"2025-06-19T15:22:40.000Z\",\n \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\": \"jane_doe\",\n \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->create(\n customer_id: \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n customer_key: \"My Company\",\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n connected_account_ids: [\"8062d457-e28e-481f-aecc-509905627511\"],\n user_identity_id: \"89765fd3-6193-4d63-8605-e77f75356555\",\n expires_at: \"2025-06-19T15:22:40.000Z\",\n);\n\n// [\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions create --customer_id \"e387e15f-be27-47ad-881f-4a6fc5460c57\" --customer_key \"My Company\" --user_identifier_key \"jane_doe\" --connect_webview_ids [\"dafe6400-7484-4fd1-8c17-1c901b444250\"] --connected_account_ids [\"8062d457-e28e-481f-aecc-509905627511\"] --user_identity_id \"89765fd3-6193-4d63-8605-e77f75356555\" --expires_at \"2025-06-19T15:22:40.000Z\"\n\n# {\n# \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n# \"connect_webview_ids\": [\n# \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n# ],\n# \"connected_account_ids\": [\n# \"8062d457-e28e-481f-aecc-509905627511\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-19T15:22:40.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }" } ] }, "put": { "description": "Creates a new [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsCreatePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) for which you want to create a client session.", "items": { "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) for which you want to create a client session.", "items": { "type": "string" }, "type": "array" }, "customer_id": { "description": "Customer ID that you want to associate with the new client session.", "type": "string" }, "customer_key": { "description": "Customer key that you want to associate with the new client session.", "minLength": 1, "type": "string" }, "expires_at": { "description": "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "format": "date-time", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user for whom you want to create a client session.", "minLength": 1, "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.", "format": "uuid", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": [ "client_session", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/client_sessions/create", "tags": [ "/client_sessions" ], "x-fern-sdk-group-name": [ "client_sessions" ], "x-fern-sdk-method-name": "create", "x-fern-sdk-return-value": "client_session", "x-response-key": "client_session", "x-title": "Create a Client Session" } }, "/client_sessions/delete": { "delete": { "description": "Deletes a [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsDeleteDelete", "parameters": [ { "in": "query", "name": "client_session_id", "required": true, "schema": { "description": "ID of the client session that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/client_sessions/delete", "tags": [ "/client_sessions" ], "x-fern-sdk-group-name": [ "client_sessions" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Client Session" }, "post": { "description": "Deletes a [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "client_session_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete a Client Session", "tags": [ "/client_sessions" ], "x-response-key": null, "x-title": "Delete a Client Session", "x-mint": { "href": "/api/client_sessions/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.delete({\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->delete(\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions delete --client_session_id \"d149de35-cfad-46fe-a78e-f71f649e7a37\"\n\n# {}" } ] } }, "/client_sessions/get": { "get": { "description": "Returns a specified [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsGetGet", "parameters": [ { "in": "query", "name": "client_session_id", "schema": { "description": "ID of the client session that you want to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "User identifier key associated with the client session that you want to get.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": [ "client_session", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/client_sessions/get", "tags": [ "/client_sessions" ], "x-fern-sdk-group-name": [ "client_sessions" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "client_session", "x-response-key": "client_session", "x-title": "Get a Client Session" }, "post": { "description": "Returns a specified [client session](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session that you want to get.", "format": "uuid", "type": "string" }, "user_identifier_key": { "description": "User identifier key associated with the client session that you want to get.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" } }, "required": [ "client_session" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Client Session", "tags": [ "/client_sessions" ], "x-response-key": "client_session", "x-title": "Get a Client Session", "x-mint": { "href": "/api/client_sessions/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.get({\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n});\n\n/*\n{\n \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\": [\n \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n ],\n \"connected_account_ids\": [\n \"8062d457-e28e-481f-aecc-509905627511\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\": 1,\n \"expires_at\": \"2025-06-19T15:22:40.000Z\",\n \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\": \"jane_doe\",\n \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->get(\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n);\n\n// [\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions get --client_session_id \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"\n\n# {\n# \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n# \"connect_webview_ids\": [\n# \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n# ],\n# \"connected_account_ids\": [\n# \"8062d457-e28e-481f-aecc-509905627511\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-19T15:22:40.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }" } ] } }, "/client_sessions/get_or_create": { "post": { "description": "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.", "operationId": "clientSessionsGetOrCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).", "items": { "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/api/connected_accounts/object) that you want to associate with the client session (or that are already associated with the existing client session).", "items": { "type": "string" }, "type": "array" }, "expires_at": { "description": "Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it.", "format": "date-time", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).", "minLength": 1, "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).", "format": "uuid", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" } }, "required": [ "client_session" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "publishable_key": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get or Create a Client Session", "tags": [ "/client_sessions" ], "x-response-key": "client_session", "x-title": "Get or Create a Client Session", "x-mint": { "href": "/api/client_sessions/get_or_create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.getOrCreate({\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n connected_account_ids: [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n user_identity_id: \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n expires_at: \"2025-06-18T06:10:42.000Z\",\n});\n\n/*\n{\n \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\": [\n \"5e297cfe-23df-4638-bb87-08c4f0f8233b\"\n ],\n \"connected_account_ids\": [\n \"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\": 1,\n \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\": \"jane_doe\",\n \"user_identity_id\": \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get_or_create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n \"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->get_or_create(\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n connected_account_ids: [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n user_identity_id: \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n expires_at: \"2025-06-18T06:10:42.000Z\",\n);\n\n// [\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n \"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions get-or-create --user_identifier_key \"jane_doe\" --connect_webview_ids [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"] --connected_account_ids [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"] --user_identity_id \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\" --expires_at \"2025-06-18T06:10:42.000Z\"\n\n# {\n# \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n# \"connect_webview_ids\": [\n# \"5e297cfe-23df-4638-bb87-08c4f0f8233b\"\n# ],\n# \"connected_account_ids\": [\n# \"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }" } ] } }, "/client_sessions/grant_access": { "patch": { "description": "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-identity), and so on.", "operationId": "clientSessionsGrantAccessPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session to which you want to grant access to resources.", "type": "string" }, "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) that you want to associate with the client session.", "items": { "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) that you want to associate with the client session.", "items": { "type": "string" }, "type": "array" }, "user_identifier_key": { "description": "Your user ID for the user that you want to associate with the client session.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_session": { "$ref": "#/components/schemas/client_session" }, "ok": { "type": "boolean" } }, "required": [ "client_session", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/client_sessions/grant_access", "tags": [ "/client_sessions" ], "x-fern-sdk-group-name": [ "client_sessions" ], "x-fern-sdk-method-name": "grant_access", "x-response-key": null, "x-title": "Grant Access to a Client Session" }, "post": { "description": "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-identity), and so on.", "operationId": "clientSessionsGrantAccessPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session to which you want to grant access to resources.", "type": "string" }, "connect_webview_ids": { "description": "IDs of the [Connect Webviews](/core-concepts/connect-webviews) that you want to associate with the client session.", "items": { "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) that you want to associate with the client session.", "items": { "type": "string" }, "type": "array" }, "user_identifier_key": { "description": "Your user ID for the user that you want to associate with the client session.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "type": "string" }, "user_identity_ids": { "deprecated": true, "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Grant Access to a Client Session", "tags": [ "/client_sessions" ], "x-response-key": null, "x-title": "Grant Access to a Client Session", "x-mint": { "href": "/api/client_sessions/grant_access" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.grantAccess({\n client_session_id: \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\",\n user_identifier_key: \"jane_doe\",\n connected_account_ids: [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n connect_webview_ids: [\"dad03fb2-f801-449c-ab88-0529728c7c38\"],\n user_identity_id: \"bde98963-3615-4e92-943e-17de3017232b\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->grant_access(\n client_session_id: \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\",\n user_identifier_key: \"jane_doe\",\n connected_account_ids: [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n connect_webview_ids: [\"dad03fb2-f801-449c-ab88-0529728c7c38\"],\n user_identity_id: \"bde98963-3615-4e92-943e-17de3017232b\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions grant-access --client_session_id \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\" --user_identifier_key \"jane_doe\" --connected_account_ids [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"] --connect_webview_ids [\"dad03fb2-f801-449c-ab88-0529728c7c38\"] --user_identity_id \"bde98963-3615-4e92-943e-17de3017232b\"\n\n# {}" } ] } }, "/client_sessions/list": { "get": { "description": "Returns a list of all [client sessions](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsListGet", "parameters": [ { "in": "query", "name": "client_session_id", "schema": { "description": "ID of the client session that you want to retrieve.", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your user ID for the user by which you want to filter client sessions.", "type": "string" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the [Connect Webview](/core-concepts/connect-webviews) for which you want to retrieve client sessions.", "type": "string" } }, { "in": "query", "name": "without_user_identifier_key", "schema": { "description": "Indicates whether to retrieve only client sessions without associated user identifier keys.", "type": "boolean" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_sessions": { "items": { "$ref": "#/components/schemas/client_session" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "client_sessions", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/client_sessions/list", "tags": [ "/client_sessions" ], "x-fern-sdk-group-name": [ "client_sessions" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "client_sessions", "x-response-key": "client_sessions", "x-title": "List Client Sessions" }, "post": { "description": "Returns a list of all [client sessions](/core-concepts/authentication/client-session-tokens).", "operationId": "clientSessionsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session that you want to retrieve.", "type": "string" }, "connect_webview_id": { "description": "ID of the [Connect Webview](/core-concepts/connect-webviews) for which you want to retrieve client sessions.", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user by which you want to filter client sessions.", "type": "string" }, "user_identity_id": { "description": "ID of the [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.", "type": "string" }, "without_user_identifier_key": { "description": "Indicates whether to retrieve only client sessions without associated user identifier keys.", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "client_sessions": { "items": { "$ref": "#/components/schemas/client_session" }, "type": "array" } }, "required": [ "client_sessions" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Client Sessions", "tags": [ "/client_sessions" ], "x-response-key": "client_sessions", "x-title": "List Client Sessions", "x-mint": { "href": "/api/client_sessions/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.list({\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n});\n\n/*\n[\n {\n \"client_session_id\": \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n \"connect_webview_ids\": [\n \"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"\n ],\n \"connected_account_ids\": [\n \"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\": 1,\n \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\": \"jane_doe\",\n \"user_identity_id\": \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n \"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\n \"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->list(\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n);\n\n// [\n [\n \"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n \"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\n \"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions list --client_session_id \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\"\n\n# [\n# {\n# \"client_session_id\": \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n# \"connect_webview_ids\": [\n# \"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"\n# ],\n# \"connected_account_ids\": [\n# \"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }\n# ]" } ] } }, "/client_sessions/revoke": { "post": { "description": "Revokes a [client session](/core-concepts/authentication/client-session-tokens).\n\nNote that [deleting a client session](/api/client_sessions/delete) is a separate action.", "operationId": "clientSessionsRevokePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "client_session_id": { "description": "ID of the client session that you want to revoke.", "format": "uuid", "type": "string" } }, "required": [ "client_session_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Revoke a Client Session", "tags": [ "/client_sessions" ], "x-response-key": null, "x-title": "Revoke a Client Session", "x-mint": { "href": "/api/client_sessions/revoke" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.clientSessions.revoke({\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/revoke\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->client_sessions->revoke(\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam client-sessions revoke --client_session_id \"4271352c-6894-4367-8f52-41d565c48f13\"\n\n# {}" } ] } }, "/connect_webviews/create": { "post": { "description": "Creates a new [Connect Webview](/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](/core-concepts/connect-webviews/connect-webview-process).", "operationId": "connectWebviewsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accepted_capabilities": { "description": "List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.", "items": { "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "type": "string" }, "type": "array" }, "accepted_providers": { "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](/api/devices/list_device_providers) with no filters.", "items": { "enum": [ "hotek", "dormakaba_community", "legic_connect", "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "schlage", "smartthings", "yale", "genie", "doorking", "salto", "salto_ks", "lockly", "ttlock", "linear", "noiseaware", "nuki", "igloo", "kwikset", "minut", "my_2n", "controlbyweb", "nest", "igloohome", "ecobee", "four_suites", "dormakaba_oracode", "pti", "wyze", "seam_passport", "visionline", "assa_abloy_credential_service", "tedee", "honeywell_resideo", "first_alert", "latch", "akiles", "assa_abloy_vostio", "assa_abloy_vostio_credential_service", "tado", "salto_space", "sensi", "keynest", "korelock", "keyincode", "dormakaba_ambiance", "ultraloq", "dusaw", "sifely", "thirty_three_lock", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi", "yale_access", "hid_cm", "google_nest", "slack" ], "type": "string" }, "type": "array" }, "automatically_manage_new_devices": { "description": "Indicates whether newly-added devices should appear as [managed devices](/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "type": "boolean" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", "type": "object" }, "custom_redirect_failure_url": { "description": "Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.", "type": "string" }, "custom_redirect_url": { "description": "URL that you want to redirect the user to after the provider login is complete.", "type": "string" }, "customer_key": { "description": "Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.", "minLength": 1, "type": "string" }, "excluded_providers": { "description": "List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account.", "items": { "type": "string" }, "type": "array" }, "provider_category": { "description": "Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](/api/devices/list_device_providers) with the desired `provider_category` filter.", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras", "connectors", "internal_beta" ], "type": "string" }, "wait_for_device_creation": { "default": false, "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" } }, "required": [ "connect_webview" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create a Connect Webview", "tags": [ "/connect_webviews" ], "x-response-key": "connect_webview", "x-title": "Create a Connect Webview", "x-mint": { "href": "/api/connect_webviews/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectWebviews.create({\n custom_redirect_url: \"https://example.com/redirect\",\n custom_redirect_failure_url: \"https://example.com/failure-redirect\",\n customer_id: \"8d7a8cc0-2e69-4bc6-85c8-545036fdd5c0\",\n provider_category: \"stable\",\n custom_metadata: { id: \"internalId1\" },\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\n \"schlage\",\n \"kwikset\",\n \"yale\",\n \"smartthings\",\n \"august\",\n \"avigilon_alta\",\n \"brivo\",\n \"nuki\",\n \"salto_ks\",\n \"salto_space\",\n \"controlbyweb\",\n \"minut\",\n \"my_2n\",\n \"ttlock\",\n \"noiseaware\",\n \"igloohome\",\n \"ecobee\",\n \"four_suites\",\n \"lockly\",\n \"wyze\",\n \"google_nest\",\n \"tede\",\n \"seam_bridge\",\n \"honeywell_resideo\",\n \"visionline\",\n \"assa_abloy_credential_service\",\n \"latch\",\n \"akiles\",\n \"sensi\",\n \"assa_abloy_vostio\"\n ],\n \"any_device_allowed\": true,\n \"any_provider_allowed\": false,\n \"authorized_at\": null,\n \"automatically_manage_new_devices\": true,\n \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\": null,\n \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n \"custom_redirect_url\": \"https://example.com/redirect\",\n \"device_selection_mode\": \"none\",\n \"login_successful\": false,\n \"selected_provider\": null,\n \"status\": \"pending\",\n \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\": true,\n \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[\n schlage\n kwikset\n yale\n smartthings\n august\n avigilon_alta\n brivo\n nuki\n salto_ks\n salto_space\n controlbyweb\n minut\n my_2n\n ttlock\n noiseaware\n igloohome\n ecobee\n four_suites\n lockly\n wyze\n google_nest\n tede\n seam_bridge\n honeywell_resideo\n visionline\n assa_abloy_credential_service\n latch\n akiles\n sensi\n assa_abloy_vostio\n ],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connect_webviews->create(\n custom_redirect_url: \"https://example.com/redirect\",\n custom_redirect_failure_url: \"https://example.com/failure-redirect\",\n customer_id: \"8d7a8cc0-2e69-4bc6-85c8-545036fdd5c0\",\n provider_category: \"stable\",\n custom_metadata: [\"id\" => \"internalId1\"],\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\n \"schlage\",\n \"kwikset\",\n \"yale\",\n \"smartthings\",\n \"august\",\n \"avigilon_alta\",\n \"brivo\",\n \"nuki\",\n \"salto_ks\",\n \"salto_space\",\n \"controlbyweb\",\n \"minut\",\n \"my_2n\",\n \"ttlock\",\n \"noiseaware\",\n \"igloohome\",\n \"ecobee\",\n \"four_suites\",\n \"lockly\",\n \"wyze\",\n \"google_nest\",\n \"tede\",\n \"seam_bridge\",\n \"honeywell_resideo\",\n \"visionline\",\n \"assa_abloy_credential_service\",\n \"latch\",\n \"akiles\",\n \"sensi\",\n \"assa_abloy_vostio\",\n ],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => null,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => null,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connect-webviews create --custom_redirect_url \"https://example.com/redirect\" --custom_redirect_failure_url \"https://example.com/failure-redirect\" --customer_id \"8d7a8cc0-2e69-4bc6-85c8-545036fdd5c0\" --provider_category \"stable\" --custom_metadata {\"id\":\"internalId1\"} --automatically_manage_new_devices true --wait_for_device_creation true --accepted_capabilities [\"lock\",\"thermostat\"]\n\n# {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\n# \"schlage\",\n# \"kwikset\",\n# \"yale\",\n# \"smartthings\",\n# \"august\",\n# \"avigilon_alta\",\n# \"brivo\",\n# \"nuki\",\n# \"salto_ks\",\n# \"salto_space\",\n# \"controlbyweb\",\n# \"minut\",\n# \"my_2n\",\n# \"ttlock\",\n# \"noiseaware\",\n# \"igloohome\",\n# \"ecobee\",\n# \"four_suites\",\n# \"lockly\",\n# \"wyze\",\n# \"google_nest\",\n# \"tede\",\n# \"seam_bridge\",\n# \"honeywell_resideo\",\n# \"visionline\",\n# \"assa_abloy_credential_service\",\n# \"latch\",\n# \"akiles\",\n# \"sensi\",\n# \"assa_abloy_vostio\"\n# ],\n# \"any_device_allowed\": true,\n# \"any_provider_allowed\": false,\n# \"authorized_at\": null,\n# \"automatically_manage_new_devices\": true,\n# \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n# \"connected_account_id\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n# \"custom_redirect_url\": \"https://example.com/redirect\",\n# \"device_selection_mode\": \"none\",\n# \"login_successful\": false,\n# \"selected_provider\": null,\n# \"status\": \"pending\",\n# \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n# \"wait_for_device_creation\": true,\n# \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n# }" } ] } }, "/connect_webviews/delete": { "delete": { "description": "Deletes a [Connect Webview](/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "operationId": "connectWebviewsDeleteDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "connect_webview_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/connect_webviews/delete", "tags": [ "/connect_webviews" ], "x-fern-sdk-group-name": [ "connect_webviews" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Connect Webview" }, "post": { "description": "Deletes a [Connect Webview](/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "operationId": "connectWebviewsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "connect_webview_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete a Connect Webview", "tags": [ "/connect_webviews" ], "x-response-key": null, "x-title": "Delete a Connect Webview", "x-mint": { "href": "/api/connect_webviews/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectWebviews.delete({\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connect_webviews->delete(\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connect-webviews delete --connect_webview_id \"816f796f-636c-46a9-9fef-7f90ca69e771\"\n\n# {}" } ] } }, "/connect_webviews/get": { "get": { "description": "Returns a specified [Connect Webview](/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "operationId": "connectWebviewsGetGet", "parameters": [ { "in": "query", "name": "connect_webview_id", "required": true, "schema": { "description": "ID of the Connect Webview that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" }, "ok": { "type": "boolean" } }, "required": [ "connect_webview", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/connect_webviews/get", "tags": [ "/connect_webviews" ], "x-fern-sdk-group-name": [ "connect_webviews" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connect_webview", "x-response-key": "connect_webview", "x-title": "Get a Connect Webview" }, "post": { "description": "Returns a specified [Connect Webview](/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "operationId": "connectWebviewsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "connect_webview_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connect_webview": { "$ref": "#/components/schemas/connect_webview" } }, "required": [ "connect_webview" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Connect Webview", "tags": [ "/connect_webviews" ], "x-response-key": "connect_webview", "x-title": "Get a Connect Webview", "x-mint": { "href": "/api/connect_webviews/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectWebviews.get({\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\n \"kwikset\",\n \"schlage\",\n \"smartthings\",\n \"yale\"\n ],\n \"any_device_allowed\": true,\n \"any_provider_allowed\": false,\n \"authorized_at\": null,\n \"automatically_manage_new_devices\": true,\n \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\": null,\n \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n \"custom_redirect_url\": \"https://example.com/redirect\",\n \"device_selection_mode\": \"none\",\n \"login_successful\": false,\n \"selected_provider\": null,\n \"status\": \"pending\",\n \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\": true,\n \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connect_webviews->get(\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => null,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => null,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connect-webviews get --connect_webview_id \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"\n\n# {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\n# \"kwikset\",\n# \"schlage\",\n# \"smartthings\",\n# \"yale\"\n# ],\n# \"any_device_allowed\": true,\n# \"any_provider_allowed\": false,\n# \"authorized_at\": null,\n# \"automatically_manage_new_devices\": true,\n# \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n# \"connected_account_id\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n# \"custom_redirect_url\": \"https://example.com/redirect\",\n# \"device_selection_mode\": \"none\",\n# \"login_successful\": false,\n# \"selected_provider\": null,\n# \"status\": \"pending\",\n# \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n# \"wait_for_device_creation\": true,\n# \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n# }" } ] } }, "/connect_webviews/list": { "get": { "description": "Returns a list of all [Connect Webviews](/core-concepts/connect-webviews).", "operationId": "connectWebviewsListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list connect webviews.", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your user ID for the user by which you want to filter Connect Webviews.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to [filter Connect Webviews](/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "type": "object" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "format": "float", "type": "number" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connect_webviews": { "items": { "$ref": "#/components/schemas/connect_webview" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "connect_webviews", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/connect_webviews/list", "tags": [ "/connect_webviews" ], "x-fern-sdk-group-name": [ "connect_webviews" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connect_webviews", "x-response-key": "connect_webviews", "x-title": "List Connect Webviews" }, "post": { "description": "Returns a list of all [Connect Webviews](/core-concepts/connect-webviews).", "operationId": "connectWebviewsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to [filter Connect Webviews](/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list connect webviews.", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`.", "minLength": 1, "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user by which you want to filter Connect Webviews.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connect_webviews": { "items": { "$ref": "#/components/schemas/connect_webview" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "connect_webviews", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Connect Webviews", "tags": [ "/connect_webviews" ], "x-response-key": "connect_webviews", "x-title": "List Connect Webviews", "x-mint": { "href": "/api/connect_webviews/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectWebviews.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\n \"kwikset\",\n \"schlage\",\n \"smartthings\",\n \"yale\"\n ],\n \"any_device_allowed\": true,\n \"any_provider_allowed\": false,\n \"authorized_at\": null,\n \"automatically_manage_new_devices\": true,\n \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\": null,\n \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n \"custom_redirect_url\": \"https://example.com/redirect\",\n \"device_selection_mode\": \"none\",\n \"login_successful\": false,\n \"selected_provider\": null,\n \"status\": \"pending\",\n \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\": true,\n \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connect_webviews->list(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => null,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => null,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => null,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connect-webviews list --customer_ids [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"] --limit 50\n\n# {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\n# \"kwikset\",\n# \"schlage\",\n# \"smartthings\",\n# \"yale\"\n# ],\n# \"any_device_allowed\": true,\n# \"any_provider_allowed\": false,\n# \"authorized_at\": null,\n# \"automatically_manage_new_devices\": true,\n# \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n# \"connected_account_id\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n# \"custom_redirect_url\": \"https://example.com/redirect\",\n# \"device_selection_mode\": \"none\",\n# \"login_successful\": false,\n# \"selected_provider\": null,\n# \"status\": \"pending\",\n# \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n# \"wait_for_device_creation\": true,\n# \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n# }" } ] } }, "/connected_accounts/delete": { "delete": { "description": "Deletes a specified [connected account](/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.", "operationId": "connectedAccountsDeleteDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/connected_accounts/delete", "tags": [ "/connected_accounts" ], "x-fern-sdk-group-name": [ "connected_accounts" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Connected Account" }, "post": { "description": "Deletes a specified [connected account](/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.", "operationId": "connectedAccountsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Delete a Connected Account", "tags": [ "/connected_accounts" ], "x-response-key": null, "x-title": "Delete a Connected Account", "x-mint": { "href": "/api/connected_accounts/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectedAccounts.delete({\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connected_accounts->delete(\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connected-accounts delete --connected_account_id \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\"\n\n# {}" } ] } }, "/connected_accounts/get": { "get": { "description": "Returns a specified [connected account](/core-concepts/connected-accounts).", "operationId": "connectedAccountsGetGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": [ "connected_account", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/connected_accounts/get", "tags": [ "/connected_accounts" ], "x-fern-sdk-group-name": [ "connected_accounts" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "connected_account", "x-response-key": "connected_account", "x-title": "Get a Connected Account" }, "post": { "description": "Returns a specified [connected account](/core-concepts/connected-accounts).", "operationId": "connectedAccountsGetPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" }, { "properties": { "email": { "description": "Email address associated with the connected account that you want to get.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" } }, "required": [ "connected_account" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get a Connected Account", "tags": [ "/connected_accounts" ], "x-response-key": "connected_account", "x-title": "Get a Connected Account", "x-mint": { "href": "/api/connected_accounts/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectedAccounts.get({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n});\n\n/*\n{\n \"account_type\": \"salto_space\",\n \"account_type_display_name\": \"Salto Space\",\n \"display_name\": \"j**n@example.com\",\n \"automatically_manage_new_devices\": true,\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"errors\": [],\n \"user_identifier\": {\n \"api_url\": \"https://example.com/api\",\n \"email\": \"jane_doe@example.com\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": []\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connected_accounts->get(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n);\n\n// [\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"errors\" => [],\n \"user_identifier\" => [\n \"api_url\" => \"https://example.com/api\",\n \"email\" => \"jane_doe@example.com\",\n \"exclusive\" => true,\n \"phone\" => \"+1555551004\",\n \"username\" => \"jane_doe\",\n ],\n \"warnings\" => [],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connected-accounts get --connected_account_id \"a289aa54-5488-4707-9a4b-eeea4edf311d\"\n\n# {\n# \"account_type\": \"salto_space\",\n# \"account_type_display_name\": \"Salto Space\",\n# \"display_name\": \"j**n@example.com\",\n# \"automatically_manage_new_devices\": true,\n# \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n# \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"errors\": [],\n# \"user_identifier\": {\n# \"api_url\": \"https://example.com/api\",\n# \"email\": \"jane_doe@example.com\",\n# \"exclusive\": true,\n# \"phone\": \"+1555551004\",\n# \"username\": \"jane_doe\"\n# },\n# \"warnings\": []\n# }" } ] } }, "/connected_accounts/list": { "get": { "description": "Returns a list of all [connected accounts](/core-concepts/connected-accounts).", "operationId": "connectedAccountsListGet", "parameters": [ { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your user ID for the user by which you want to filter connected accounts.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.", "type": "object" } }, { "in": "query", "name": "customer_key", "schema": { "description": "Customer key by which you want to filter connected accounts.", "type": "string" } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space by which you want to filter connected accounts.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 11000, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "connected_accounts", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/connected_accounts/list", "tags": [ "/connected_accounts" ], "x-fern-sdk-group-name": [ "connected_accounts" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "connected_accounts", "x-response-key": "connected_accounts", "x-title": "List Connected Accounts" }, "post": { "description": "Returns a list of all [connected accounts](/core-concepts/connected-accounts).", "operationId": "connectedAccountsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.", "type": "object" }, "customer_key": { "description": "Customer key by which you want to filter connected accounts.", "type": "string" }, "limit": { "default": 11000, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space by which you want to filter connected accounts.", "format": "uuid", "type": "string" }, "user_identifier_key": { "description": "Your user ID for the user by which you want to filter connected accounts.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "connected_accounts", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "List Connected Accounts", "tags": [ "/connected_accounts" ], "x-response-key": "connected_accounts", "x-title": "List Connected Accounts", "x-mint": { "href": "/api/connected_accounts/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectedAccounts.list({\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n});\n\n/*\n[\n {\n \"account_type\": \"salto_space\",\n \"account_type_display_name\": \"Salto Space\",\n \"display_name\": \"j**n@example.com\",\n \"automatically_manage_new_devices\": true,\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"errors\": [],\n \"user_identifier\": {\n \"api_url\": \"https://example.com/api\",\n \"email\": \"jane_doe@example.com\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": []\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connected_accounts->list(\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n);\n\n// [\n [\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"errors\" => [],\n \"user_identifier\" => [\n \"api_url\" => \"https://example.com/api\",\n \"email\" => \"jane_doe@example.com\",\n \"exclusive\" => true,\n \"phone\" => \"+1555551004\",\n \"username\" => \"jane_doe\",\n ],\n \"warnings\" => [],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connected-accounts list --user_identifier_key \"2f393937-1405-4b1a-933f-34c97bfb3c56\" --limit 50\n\n# [\n# {\n# \"account_type\": \"salto_space\",\n# \"account_type_display_name\": \"Salto Space\",\n# \"display_name\": \"j**n@example.com\",\n# \"automatically_manage_new_devices\": true,\n# \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n# \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"errors\": [],\n# \"user_identifier\": {\n# \"api_url\": \"https://example.com/api\",\n# \"email\": \"jane_doe@example.com\",\n# \"exclusive\": true,\n# \"phone\": \"+1555551004\",\n# \"username\": \"jane_doe\"\n# },\n# \"warnings\": []\n# }\n# ]" } ] } }, "/connected_accounts/simulate/disconnect": { "post": { "description": "Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](/core-concepts/workspaces#sandbox-workspaces).", "operationId": "connectedAccountsSimulateDisconnectPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account you want to simulate as disconnected.", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Connected Account Disconnection", "tags": [ "/connected_accounts" ], "x-response-key": null, "x-title": "Simulate Connected Account Disconnection", "x-mint": { "href": "/api/connected_accounts/simulate/disconnect" } } }, "/connected_accounts/sync": { "post": { "description": "Request a [connected account](/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.", "operationId": "connectedAccountsSyncPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to sync.", "format": "uuid", "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Sync a Connected Account", "tags": [ "/connected_accounts" ], "x-response-key": null, "x-title": "Sync a Connected Account", "x-mint": { "href": "/api/connected_accounts/sync" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectedAccounts.sync({\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/sync\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connected_accounts->sync(\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connected-accounts sync --connected_account_id \"f886f890-4ca5-4ce5-b248-509cbfb6c279\"\n\n# {}" } ] } }, "/connected_accounts/update": { "patch": { "description": "Updates a [connected account](/core-concepts/connected-accounts).", "operationId": "connectedAccountsUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accepted_capabilities": { "description": "List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.", "items": { "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "type": "string" }, "type": "array" }, "automatically_manage_new_devices": { "description": "Indicates whether newly-added devices should appear as [managed devices](/core-concepts/devices/managed-and-unmanaged-devices).", "type": "boolean" }, "connected_account_id": { "description": "ID of the connected account that you want to update.", "format": "uuid", "type": "string" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).", "type": "object" }, "customer_key": { "description": "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.", "minLength": 1, "type": "string" }, "display_name": { "description": "Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "connected_account": { "$ref": "#/components/schemas/connected_account" }, "ok": { "type": "boolean" } }, "required": [ "connected_account", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/connected_accounts/update", "tags": [ "/connected_accounts" ], "x-fern-sdk-group-name": [ "connected_accounts" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Connected Account" }, "post": { "description": "Updates a [connected account](/core-concepts/connected-accounts).", "operationId": "connectedAccountsUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accepted_capabilities": { "description": "List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.", "items": { "description": "\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n", "enum": [ "lock", "thermostat", "noise_sensor", "access_control", "camera" ], "type": "string" }, "type": "array" }, "automatically_manage_new_devices": { "description": "Indicates whether newly-added devices should appear as [managed devices](/core-concepts/devices/managed-and-unmanaged-devices).", "type": "boolean" }, "connected_account_id": { "description": "ID of the connected account that you want to update.", "format": "uuid", "type": "string" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).", "type": "object" }, "customer_key": { "description": "The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.", "minLength": 1, "type": "string" }, "display_name": { "description": "Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update a Connected Account", "tags": [ "/connected_accounts" ], "x-response-key": null, "x-title": "Update a Connected Account", "x-mint": { "href": "/api/connected_accounts/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.connectedAccounts.update({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->connected_accounts->update(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam connected-accounts update --connected_account_id \"a289aa54-5488-4707-9a4b-eeea4edf311d\" --automatically_manage_new_devices true --custom_metadata {\"id\":\"internalId1\"}\n\n# {}" } ] } }, "/customers/create_portal": { "post": { "description": "Creates a new customer portal magic link with configurable features.", "operationId": "customersCreatePortalPost", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "default": { "exclude_locale_picker": false, "features": { "configure": { "allow_access_automation_rule_customization": false, "allow_climate_automation_rule_customization": false, "allow_instant_key_customization": false, "exclude": false }, "connect": { "exclude": false }, "manage": { "exclude": false, "exclude_reservation_management": false, "exclude_reservation_technical_details": false, "exclude_staff_management": false }, "manage_devices": { "exclude": false }, "organize": { "exclude": false } }, "is_embedded": false }, "description": "Configuration for a customer portal", "properties": { "customer_resources_filters": { "description": "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.", "items": { "properties": { "field": { "description": "The custom_metadata field name to filter on.", "pattern": "^[a-zA-Z_]\\w*$", "type": "string" }, "operation": { "description": "The comparison operation. Currently only '=' is supported.", "enum": [ "=" ], "type": "string" }, "value": { "description": "The value to compare against.", "oneOf": [ { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "field", "operation", "value" ], "type": "object" }, "type": "array" }, "customization_profile_id": { "description": "The ID of the customization profile to use for the portal.", "format": "uuid", "type": "string" }, "exclude_locale_picker": { "default": false, "description": "Whether to exclude the option to select a locale within the portal UI.", "type": "boolean" }, "features": { "default": {}, "properties": { "configure": { "default": {}, "description": "Configuration for the configure feature.", "properties": { "allow_access_automation_rule_customization": { "default": false, "description": "Indicates whether the customer can customize the access automation rules for their properties.", "type": "boolean" }, "allow_climate_automation_rule_customization": { "default": false, "description": "Indicates whether the customer can customize the climate automation rules for their properties.", "type": "boolean" }, "allow_instant_key_customization": { "default": false, "description": "Indicates whether the customer can customize the Instant Key profile for their properties.", "type": "boolean" }, "exclude": { "default": false, "description": "Whether to exclude this feature from the portal.", "type": "boolean" } }, "type": "object" }, "connect": { "default": {}, "description": "Configuration for the connect accounts feature.", "properties": { "accepted_providers": { "description": "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.", "items": { "type": "string" }, "type": "array" }, "exclude": { "default": false, "description": "Whether to exclude this feature from the portal.", "type": "boolean" }, "excluded_providers": { "description": "List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "manage": { "default": {}, "description": "Configuration for the manage feature.", "properties": { "device_management_confirmation": { "description": "\n Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.\n ", "properties": { "body": { "description": "Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.", "type": "string" }, "cancel_button_label": { "description": "Custom label for the cancel button.", "type": "string" }, "confirm_button_label": { "description": "Custom label for the confirm button.", "type": "string" }, "title": { "description": "Custom title for the confirmation modal.", "type": "string" } }, "type": "object" }, "events": { "description": "Configuration for event type filtering in the manage feature.", "properties": { "allowed_events": { "description": "List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.", "items": { "type": "string" }, "type": "array" }, "default_events": { "description": "List of event types that are pre-selected in the events filter when the user first loads the events tab.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "exclude": { "default": false, "description": "Whether to exclude this feature from the portal.", "type": "boolean" }, "exclude_reservation_management": { "default": false, "description": "Indicates whether the customer can manage reservations for their properties.", "type": "boolean" }, "exclude_reservation_technical_details": { "default": false, "description": "Indicates whether to exclude technical details from reservation views.", "type": "boolean" }, "exclude_staff_management": { "default": false, "description": "Indicates whether the customer can manage staff for their properties.", "type": "boolean" } }, "type": "object" }, "manage_devices": { "default": {}, "description": "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---", "properties": { "exclude": { "default": false, "description": "Whether to exclude this feature from the portal.", "type": "boolean" } }, "type": "object" }, "organize": { "default": {}, "description": "Configuration for the organize feature.", "properties": { "exclude": { "default": false, "description": "Whether to exclude this feature from the portal.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "is_embedded": { "default": false, "description": "Whether the portal is embedded in another application.", "type": "boolean" }, "landing_page": { "description": "Configuration for the landing page when the portal loads.", "properties": { "manage": { "oneOf": [ { "oneOf": [ { "properties": { "space_key": { "type": "string" } }, "required": [ "space_key" ], "type": "object" }, { "properties": { "property_key": { "type": "string" } }, "required": [ "property_key" ], "type": "object" }, { "properties": { "room_key": { "type": "string" } }, "required": [ "room_key" ], "type": "object" }, { "properties": { "common_area_key": { "type": "string" } }, "required": [ "common_area_key" ], "type": "object" }, { "properties": { "unit_key": { "type": "string" } }, "required": [ "unit_key" ], "type": "object" }, { "properties": { "facility_key": { "type": "string" } }, "required": [ "facility_key" ], "type": "object" }, { "properties": { "building_key": { "type": "string" } }, "required": [ "building_key" ], "type": "object" }, { "properties": { "listing_key": { "type": "string" } }, "required": [ "listing_key" ], "type": "object" }, { "properties": { "property_listing_key": { "type": "string" } }, "required": [ "property_listing_key" ], "type": "object" }, { "properties": { "site_key": { "type": "string" } }, "required": [ "site_key" ], "type": "object" } ] }, { "oneOf": [ { "properties": { "reservation_key": { "type": "string" } }, "required": [ "reservation_key" ], "type": "object" }, { "properties": { "booking_key": { "type": "string" } }, "required": [ "booking_key" ], "type": "object" }, { "properties": { "access_grant_key": { "type": "string" } }, "required": [ "access_grant_key" ], "type": "object" } ] } ] } }, "type": "object" }, "locale": { "description": "The locale to use for the portal.", "enum": [ "en-US", "pt-PT", "fr-FR", "it-IT", "es-ES", "de-DE", "nl-NL", "el-GR", "pl-PL", "ru-RU" ], "type": "string" }, "navigation_mode": { "default": "full", "description": "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.", "enum": [ "full", "restricted" ], "type": "string" } }, "type": "object" }, { "properties": { "customer_data": { "properties": { "access_grants": { "description": "List of access grants.", "items": { "properties": { "access_grant_key": { "description": "Your unique identifier for the access grant.", "minLength": 1, "type": "string" }, "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "access_grant_key" ], "type": "object" }, "type": "array" }, "bookings": { "description": "List of bookings.", "items": { "properties": { "booking_key": { "description": "Your unique identifier for the booking.", "minLength": 1, "type": "string" }, "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "booking_key" ], "type": "object" }, "type": "array" }, "buildings": { "description": "List of buildings.", "items": { "properties": { "building_key": { "description": "Your unique identifier for the building.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "building_key" ], "type": "object" }, "type": "array" }, "common_areas": { "description": "List of shared common areas.", "items": { "properties": { "common_area_key": { "description": "Your unique identifier for the common area.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "common_area_key" ], "type": "object" }, "type": "array" }, "customer_key": { "description": "Your unique identifier for the customer.", "minLength": 1, "type": "string" }, "facilities": { "description": "List of gym or fitness facilities.", "items": { "properties": { "facility_key": { "description": "Your unique identifier for the facility.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "facility_key" ], "type": "object" }, "type": "array" }, "guests": { "description": "List of guests.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "guest_key": { "description": "Your unique identifier for the guest.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" } }, "required": [ "name", "guest_key" ], "type": "object" }, "type": "array" }, "listings": { "description": "List of property listings.", "items": { "properties": { "listing_key": { "description": "Your unique identifier for the listing.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "listing_key" ], "type": "object" }, "type": "array" }, "properties": { "description": "List of short-term rental properties.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "property_key": { "description": "Your unique identifier for the property.", "minLength": 1, "type": "string" } }, "required": [ "name", "property_key" ], "type": "object" }, "type": "array" }, "property_listings": { "description": "List of property listings.", "items": { "properties": { "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "property_listing_key": { "description": "Your unique identifier for the property listing.", "minLength": 1, "type": "string" } }, "required": [ "name", "property_listing_key" ], "type": "object" }, "type": "array" }, "reservations": { "description": "List of reservations.", "items": { "properties": { "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Set key:value pairs for filtering reservations by custom criteria.", "type": "object" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "reservation_key": { "description": "Your unique identifier for the reservation.", "minLength": 1, "type": "string" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "reservation_key" ], "type": "object" }, "type": "array" }, "residents": { "description": "List of residents.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "resident_key": { "description": "Your unique identifier for the resident.", "minLength": 1, "type": "string" } }, "required": [ "name", "resident_key" ], "type": "object" }, "type": "array" }, "rooms": { "description": "List of hotel or hospitality rooms.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "room_key": { "description": "Your unique identifier for the room.", "minLength": 1, "type": "string" } }, "required": [ "name", "room_key" ], "type": "object" }, "type": "array" }, "sites": { "description": "List of general sites or areas.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "site_key" ], "type": "object" }, "type": "array" }, "spaces": { "description": "List of general spaces or areas.", "items": { "properties": { "customer_data": { "description": "Reservation/stay-related defaults for the space (time zone, default check-in/out times, address).", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "duration_minutes": { "description": "Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "geolocation": { "description": "Geographic coordinates (latitude and longitude) of the space.", "properties": { "latitude": { "description": "Latitude of the space, in decimal degrees.", "format": "float", "type": "number" }, "longitude": { "description": "Longitude of the space, in decimal degrees.", "format": "float", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "space_key": { "description": "Your unique identifier for the space.", "minLength": 1, "type": "string" } }, "required": [ "name", "space_key" ], "type": "object" }, "type": "array" }, "staff_members": { "description": "List of staff members.", "items": { "description": "Represents a staff member for a specific customer.", "properties": { "building_keys": { "description": "List of unique identifiers for the buildings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "List of unique identifiers for the common areas the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "facility_keys": { "description": "List of unique identifiers for the facilities the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "listing_keys": { "description": "List of unique identifiers for the listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "property_keys": { "description": "List of unique identifiers for the properties the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "property_listing_keys": { "description": "List of unique identifiers for the property listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "room_keys": { "description": "List of unique identifiers for the rooms the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "site_keys": { "description": "List of unique identifiers for the sites the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "List of unique identifiers for the spaces the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "staff_member_key": { "description": "Your unique identifier for the staff.", "type": "string" }, "unit_keys": { "description": "List of unique identifiers for the units the staff member is associated with.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "staff_member_key" ], "type": "object", "x-route-path": "/seam/customer/v1/staff_members" }, "type": "array" }, "tenants": { "description": "List of tenants.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "tenant_key": { "description": "Your unique identifier for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "name", "tenant_key" ], "type": "object" }, "type": "array" }, "units": { "description": "List of multi-family residential units.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "unit_key": { "description": "Your unique identifier for the unit.", "minLength": 1, "type": "string" } }, "required": [ "name", "unit_key" ], "type": "object" }, "type": "array" }, "user_identities": { "description": "List of user identities.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "user_identity_key": { "description": "Your unique identifier for the user identity.", "minLength": 1, "type": "string" } }, "required": [ "name", "user_identity_key" ], "type": "object" }, "type": "array" }, "users": { "description": "List of users.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "user_key": { "description": "Your unique identifier for the user.", "minLength": 1, "type": "string" } }, "required": [ "name", "user_key" ], "type": "object" }, "type": "array" } }, "required": [ "customer_key" ], "type": "object" } }, "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customer_portal": { "$ref": "#/components/schemas/customer_portal" } }, "required": [ "customer_portal" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create Customer Portal", "tags": [], "x-response-key": "customer_portal", "x-title": "Create Customer Portal", "x-mint": { "href": "/api/customers/create_portal" } } }, "/customers/delete_data": { "delete": { "description": "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).", "operationId": "customersDeleteDataDelete", "parameters": [ { "in": "query", "name": "customer_keys", "schema": { "description": "List of customer keys to delete all data for.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "space_keys", "schema": { "description": "List of space keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "property_keys", "schema": { "description": "List of property keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "room_keys", "schema": { "description": "List of room keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "common_area_keys", "schema": { "description": "List of common area keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "unit_keys", "schema": { "description": "List of unit keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "facility_keys", "schema": { "description": "List of facility keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "building_keys", "schema": { "description": "List of building keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "listing_keys", "schema": { "description": "List of listing keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "property_listing_keys", "schema": { "description": "List of property listing keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "guest_keys", "schema": { "description": "List of guest keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "tenant_keys", "schema": { "description": "List of tenant keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "resident_keys", "schema": { "description": "List of resident keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "user_keys", "schema": { "description": "List of user keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "user_identity_keys", "schema": { "description": "List of user identity keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "reservation_keys", "schema": { "description": "List of reservation keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "booking_keys", "schema": { "description": "List of booking keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "access_grant_keys", "schema": { "description": "List of access grant keys to delete.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "staff_member_keys", "schema": { "description": "List of staff member keys to delete.", "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/customers/delete_data", "tags": [], "x-fern-sdk-group-name": [ "customers" ], "x-fern-sdk-method-name": "delete_data", "x-response-key": null, "x-title": "Delete Customer Data" }, "post": { "description": "Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).", "operationId": "customersDeleteDataPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grant_keys": { "description": "List of access grant keys to delete.", "items": { "type": "string" }, "type": "array" }, "booking_keys": { "description": "List of booking keys to delete.", "items": { "type": "string" }, "type": "array" }, "building_keys": { "description": "List of building keys to delete.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "List of common area keys to delete.", "items": { "type": "string" }, "type": "array" }, "customer_keys": { "description": "List of customer keys to delete all data for.", "items": { "type": "string" }, "type": "array" }, "facility_keys": { "description": "List of facility keys to delete.", "items": { "type": "string" }, "type": "array" }, "guest_keys": { "description": "List of guest keys to delete.", "items": { "type": "string" }, "type": "array" }, "listing_keys": { "description": "List of listing keys to delete.", "items": { "type": "string" }, "type": "array" }, "property_keys": { "description": "List of property keys to delete.", "items": { "type": "string" }, "type": "array" }, "property_listing_keys": { "description": "List of property listing keys to delete.", "items": { "type": "string" }, "type": "array" }, "reservation_keys": { "description": "List of reservation keys to delete.", "items": { "type": "string" }, "type": "array" }, "resident_keys": { "description": "List of resident keys to delete.", "items": { "type": "string" }, "type": "array" }, "room_keys": { "description": "List of room keys to delete.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "List of space keys to delete.", "items": { "type": "string" }, "type": "array" }, "staff_member_keys": { "description": "List of staff member keys to delete.", "items": { "type": "string" }, "type": "array" }, "tenant_keys": { "description": "List of tenant keys to delete.", "items": { "type": "string" }, "type": "array" }, "unit_keys": { "description": "List of unit keys to delete.", "items": { "type": "string" }, "type": "array" }, "user_identity_keys": { "description": "List of user identity keys to delete.", "items": { "type": "string" }, "type": "array" }, "user_keys": { "description": "List of user keys to delete.", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete Customer Data", "tags": [], "x-response-key": null, "x-title": "Delete Customer Data", "x-mint": { "href": "/api/customers/delete_data" } } }, "/customers/push_data": { "post": { "description": "Pushes customer data including resources like spaces, properties, rooms, users, etc.", "operationId": "customersPushDataPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_grants": { "description": "List of access grants.", "items": { "properties": { "access_grant_key": { "description": "Your unique identifier for the access grant.", "minLength": 1, "type": "string" }, "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "access_grant_key" ], "type": "object" }, "type": "array" }, "bookings": { "description": "List of bookings.", "items": { "properties": { "booking_key": { "description": "Your unique identifier for the booking.", "minLength": 1, "type": "string" }, "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "booking_key" ], "type": "object" }, "type": "array" }, "buildings": { "description": "List of buildings.", "items": { "properties": { "building_key": { "description": "Your unique identifier for the building.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "building_key" ], "type": "object" }, "type": "array" }, "common_areas": { "description": "List of shared common areas.", "items": { "properties": { "common_area_key": { "description": "Your unique identifier for the common area.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "common_area_key" ], "type": "object" }, "type": "array" }, "customer_key": { "description": "Your unique identifier for the customer.", "minLength": 1, "type": "string" }, "facilities": { "description": "List of gym or fitness facilities.", "items": { "properties": { "facility_key": { "description": "Your unique identifier for the facility.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "facility_key" ], "type": "object" }, "type": "array" }, "guests": { "description": "List of guests.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "guest_key": { "description": "Your unique identifier for the guest.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" } }, "required": [ "name", "guest_key" ], "type": "object" }, "type": "array" }, "listings": { "description": "List of property listings.", "items": { "properties": { "listing_key": { "description": "Your unique identifier for the listing.", "minLength": 1, "type": "string" }, "name": { "description": "Your display name for this location resource.", "type": "string" } }, "required": [ "name", "listing_key" ], "type": "object" }, "type": "array" }, "properties": { "description": "List of short-term rental properties.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "property_key": { "description": "Your unique identifier for the property.", "minLength": 1, "type": "string" } }, "required": [ "name", "property_key" ], "type": "object" }, "type": "array" }, "property_listings": { "description": "List of property listings.", "items": { "properties": { "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.", "type": "object" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "property_listing_key": { "description": "Your unique identifier for the property listing.", "minLength": 1, "type": "string" } }, "required": [ "name", "property_listing_key" ], "type": "object" }, "type": "array" }, "reservations": { "description": "List of reservations.", "items": { "properties": { "building_keys": { "description": "Building keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "Common area keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Set key:value pairs for filtering reservations by custom criteria.", "type": "object" }, "ends_at": { "description": "Ending date and time for the access grant.", "format": "date-time", "type": "string" }, "facility_keys": { "description": "Facility keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "guest_key": { "description": "Guest key associated with the access grant.", "type": "string" }, "listing_keys": { "description": "Listing keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your name for this access grant resource.", "type": "string" }, "preferred_code": { "description": "Preferred PIN code to use when creating access for this reservation.", "type": "string" }, "property_keys": { "description": "Property keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "reservation_key": { "description": "Your unique identifier for the reservation.", "minLength": 1, "type": "string" }, "resident_key": { "description": "Resident key associated with the access grant.", "type": "string" }, "room_keys": { "description": "Room keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "Space keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "starts_at": { "description": "Starting date and time for the access grant.", "format": "date-time", "type": "string" }, "tenant_key": { "description": "Tenant key associated with the access grant.", "type": "string" }, "unit_keys": { "description": "Unit keys associated with the access grant.", "items": { "type": "string" }, "type": "array" }, "user_identity_key": { "description": "User identity key associated with the access grant.", "type": "string" }, "user_key": { "description": "User key associated with the access grant.", "type": "string" } }, "required": [ "reservation_key" ], "type": "object" }, "type": "array" }, "residents": { "description": "List of residents.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "resident_key": { "description": "Your unique identifier for the resident.", "minLength": 1, "type": "string" } }, "required": [ "name", "resident_key" ], "type": "object" }, "type": "array" }, "rooms": { "description": "List of hotel or hospitality rooms.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "room_key": { "description": "Your unique identifier for the room.", "minLength": 1, "type": "string" } }, "required": [ "name", "room_key" ], "type": "object" }, "type": "array" }, "sites": { "description": "List of general sites or areas.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" } }, "required": [ "name", "site_key" ], "type": "object" }, "type": "array" }, "spaces": { "description": "List of general spaces or areas.", "items": { "properties": { "customer_data": { "description": "Reservation/stay-related defaults for the space (time zone, default check-in/out times, address).", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "duration_minutes": { "description": "Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "geolocation": { "description": "Geographic coordinates (latitude and longitude) of the space.", "properties": { "latitude": { "description": "Latitude of the space, in decimal degrees.", "format": "float", "type": "number" }, "longitude": { "description": "Longitude of the space, in decimal degrees.", "format": "float", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "space_key": { "description": "Your unique identifier for the space.", "minLength": 1, "type": "string" } }, "required": [ "name", "space_key" ], "type": "object" }, "type": "array" }, "staff_members": { "description": "List of staff members.", "items": { "description": "Represents a staff member for a specific customer.", "properties": { "building_keys": { "description": "List of unique identifiers for the buildings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "common_area_keys": { "description": "List of unique identifiers for the common areas the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "facility_keys": { "description": "List of unique identifiers for the facilities the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "listing_keys": { "description": "List of unique identifiers for the listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "property_keys": { "description": "List of unique identifiers for the properties the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "property_listing_keys": { "description": "List of unique identifiers for the property listings the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "room_keys": { "description": "List of unique identifiers for the rooms the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "site_keys": { "description": "List of unique identifiers for the sites the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "space_keys": { "description": "List of unique identifiers for the spaces the staff member is associated with.", "items": { "type": "string" }, "type": "array" }, "staff_member_key": { "description": "Your unique identifier for the staff.", "type": "string" }, "unit_keys": { "description": "List of unique identifiers for the units the staff member is associated with.", "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "staff_member_key" ], "type": "object", "x-route-path": "/seam/customer/v1/staff_members" }, "type": "array" }, "tenants": { "description": "List of tenants.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "tenant_key": { "description": "Your unique identifier for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "name", "tenant_key" ], "type": "object" }, "type": "array" }, "units": { "description": "List of multi-family residential units.", "items": { "properties": { "name": { "description": "Your display name for this location resource.", "type": "string" }, "parent_site_key": { "description": "Your unique identifier for the site.", "minLength": 1, "type": "string" }, "unit_key": { "description": "Your unique identifier for the unit.", "minLength": 1, "type": "string" } }, "required": [ "name", "unit_key" ], "type": "object" }, "type": "array" }, "user_identities": { "description": "List of user identities.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "user_identity_key": { "description": "Your unique identifier for the user identity.", "minLength": 1, "type": "string" } }, "required": [ "name", "user_identity_key" ], "type": "object" }, "type": "array" }, "users": { "description": "List of users.", "items": { "properties": { "email_address": { "description": "Email address associated with the user identity.", "type": "string" }, "name": { "description": "Your display name for this user identity resource.", "type": "string" }, "phone_number": { "description": "Phone number associated with the user identity.", "type": "string" }, "user_key": { "description": "Your unique identifier for the user.", "minLength": 1, "type": "string" } }, "required": [ "name", "user_key" ], "type": "object" }, "type": "array" } }, "required": [ "customer_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Push Customer Data", "tags": [], "x-response-key": null, "x-title": "Push Customer Data", "x-mint": { "href": "/api/customers/push_data" } } }, "/devices/get": { "get": { "description": "Returns a specified [device](/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesGetGet", "parameters": [ { "in": "query", "name": "device_id", "schema": { "description": "ID of the device that you want to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "name", "schema": { "description": "Name of the device that you want to get.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": [ "device", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/devices/get", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device", "x-response-key": "device", "x-title": "Get a Device" }, "post": { "description": "Returns a specified [device](/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that you want to get.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the device that you want to get.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/device" } }, "required": [ "device" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Device", "tags": [ "/devices" ], "x-response-key": "device", "x-title": "Get a Device", "x-mint": { "href": "/api/devices/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.get({ device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\" });\n\n/*\n{\n \"can_hvac_cool\": true,\n \"can_hvac_heat\": true,\n \"can_hvac_heat_cool\": true,\n \"can_turn_off_hvac\": true,\n \"capabilities_supported\": [\n \"thermostat\"\n ],\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\": \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"device_type\": \"ecobee_thermostat\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"active_climate_preset\": {\n \"can_delete\": true,\n \"can_edit\": true,\n \"climate_preset_key\": \"sleep\",\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 17.77777777777778,\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true\n },\n \"appearance\": {\n \"name\": \"My Device\"\n },\n \"available_climate_presets\": [\n {\n \"climate_preset_key\": \"sleep\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Sleep\",\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"home\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Home\",\n \"display_name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"work\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Work\",\n \"display_name\": \"Work\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n }\n ],\n \"available_fan_mode_settings\": [\n \"auto\",\n \"on\"\n ],\n \"available_hvac_mode_settings\": [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\"\n ],\n \"current_climate_setting\": {\n \"display_name\": \"Manual Setting\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 25,\n \"heating_set_point_fahrenheit\": 77,\n \"hvac_mode_setting\": \"heat\",\n \"manual_override_allowed\": true\n },\n \"ecobee_metadata\": {\n \"device_name\": \"Living Room\",\n \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n },\n \"fallback_climate_preset_key\": \"eco\",\n \"fan_mode_setting\": \"auto\",\n \"has_direct_power\": true,\n \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\": false,\n \"is_fan_running\": false,\n \"is_heating\": false,\n \"is_temporary_manual_override_active\": false,\n \"manufacturer\": \"ecobee\",\n \"max_cooling_set_point_celsius\": 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\": 92,\n \"max_heating_set_point_celsius\": 26.11111111111111,\n \"max_heating_set_point_fahrenheit\": 79,\n \"min_cooling_set_point_celsius\": 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\": 65,\n \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\": 5,\n \"min_heating_set_point_celsius\": 7.222222222222222,\n \"min_heating_set_point_fahrenheit\": 45,\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Ecobee\"\n },\n \"name\": \"My Device\",\n \"online\": true,\n \"relative_humidity\": 0.36,\n \"temperature_celsius\": 21.11111111111111,\n \"temperature_fahrenheit\": 70,\n \"temperature_threshold\": {\n \"lower_limit_celsius\": 16.66666666666667,\n \"lower_limit_fahrenheit\": 62,\n \"upper_limit_celsius\": 26.66666666666667,\n \"upper_limit_fahrenheit\": 80\n },\n \"thermostat_daily_programs\": [\n {\n \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"work\"\n },\n {\n \"starts_at_time\": \"18:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"22:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:01:25.455Z\"\n },\n {\n \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"name\": \"Weekend Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"08:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"23:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:02:19.952Z\"\n }\n ],\n \"thermostat_weekly_program\": null\n },\n \"warnings\": [],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"My Device\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"My Device\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\");\n\n// [\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"active_climate_preset\" => [\n \"can_delete\" => true,\n \"can_edit\" => true,\n \"climate_preset_key\" => \"sleep\",\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n ],\n \"appearance\" => [\"name\" => \"My Device\"],\n \"available_climate_presets\" => [\n [\n \"climate_preset_key\" => \"sleep\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Sleep\",\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"home\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Home\",\n \"display_name\" => \"Home\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"work\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Work\",\n \"display_name\" => \"Work\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n ],\n \"available_fan_mode_settings\" => [\"auto\", \"on\"],\n \"available_hvac_mode_settings\" => [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\" => [\n \"display_name\" => \"Manual Setting\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 25,\n \"heating_set_point_fahrenheit\" => 77,\n \"hvac_mode_setting\" => \"heat\",\n \"manual_override_allowed\" => true,\n ],\n \"ecobee_metadata\" => [\n \"device_name\" => \"Living Room\",\n \"ecobee_device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n ],\n \"fallback_climate_preset_key\" => \"eco\",\n \"fan_mode_setting\" => \"auto\",\n \"has_direct_power\" => true,\n \"image_alt_text\" => \"Ecobee 3 Lite Thermostat\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\" => false,\n \"is_fan_running\" => false,\n \"is_heating\" => false,\n \"is_temporary_manual_override_active\" => false,\n \"manufacturer\" => \"ecobee\",\n \"max_cooling_set_point_celsius\" => 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\" => 92,\n \"max_heating_set_point_celsius\" => 26.11111111111111,\n \"max_heating_set_point_fahrenheit\" => 79,\n \"min_cooling_set_point_celsius\" => 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\" => 65,\n \"min_heating_cooling_delta_celsius\" => 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\" => 5,\n \"min_heating_set_point_celsius\" => 7.222222222222222,\n \"min_heating_set_point_fahrenheit\" => 45,\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Ecobee\",\n ],\n \"name\" => \"My Device\",\n \"online\" => true,\n \"relative_humidity\" => 0.36,\n \"temperature_celsius\" => 21.11111111111111,\n \"temperature_fahrenheit\" => 70,\n \"temperature_threshold\" => [\n \"lower_limit_celsius\" => 16.66666666666667,\n \"lower_limit_fahrenheit\" => 62,\n \"upper_limit_celsius\" => 26.66666666666667,\n \"upper_limit_fahrenheit\" => 80,\n ],\n \"thermostat_daily_programs\" => [\n [\n \"thermostat_daily_program_id\" =>\n \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"07:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"09:00:00\",\n \"climate_preset_key\" => \"work\",\n ],\n [\n \"starts_at_time\" => \"18:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"22:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:01:25.455Z\",\n ],\n [\n \"thermostat_daily_program_id\" =>\n \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"name\" => \"Weekend Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"08:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"23:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:02:19.952Z\",\n ],\n ],\n \"thermostat_weekly_program\" => null,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices get --device_id \"a75bff05-29a3-4215-a09f-2156c52a4ac7\"\n\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"My Device\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"My Device\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }" } ] } }, "/devices/list": { "get": { "description": "Returns a list of all [devices](/core-concepts/devices).", "operationId": "devicesListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_ids", "schema": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_type", "schema": { "description": "Device type for which you want to list devices.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] } }, { "in": "query", "name": "device_types", "schema": { "description": "Array of device types for which you want to list devices.", "items": { "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "type": "array" } }, { "in": "query", "name": "manufacturer", "schema": { "description": "Manufacturer for which you want to list devices.", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi", "slack" ], "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "unstable_location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "devices", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/devices/list", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Devices" }, "post": { "description": "Returns a list of all [devices](/core-concepts/devices).", "operationId": "devicesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_ids": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_before": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" }, "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list devices.", "type": "string" }, "device_ids": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_type": { "description": "Device type for which you want to list devices.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "device_types": { "description": "Array of device types for which you want to list devices.", "items": { "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "type": "array" }, "limit": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" }, "manufacturer": { "description": "Manufacturer for which you want to list devices.", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi", "slack" ], "type": "string" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" }, "unstable_location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "devices", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session_with_customer": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Devices", "tags": [ "/devices" ], "x-response-key": "devices", "x-title": "List Devices", "x-mint": { "href": "/api/devices/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.list({\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\n});\n\n/*\n[\n {\n \"can_hvac_cool\": true,\n \"can_hvac_heat\": true,\n \"can_hvac_heat_cool\": true,\n \"can_turn_off_hvac\": true,\n \"capabilities_supported\": [\n \"thermostat\"\n ],\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\": \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\": \"ecobee_thermostat\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"active_climate_preset\": {\n \"can_delete\": true,\n \"can_edit\": true,\n \"climate_preset_key\": \"sleep\",\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 17.77777777777778,\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true\n },\n \"appearance\": {\n \"name\": \"Living Room\"\n },\n \"available_climate_presets\": [\n {\n \"climate_preset_key\": \"sleep\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Sleep\",\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"home\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Home\",\n \"display_name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"work\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Work\",\n \"display_name\": \"Work\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n }\n ],\n \"available_fan_mode_settings\": [\n \"auto\",\n \"on\"\n ],\n \"available_hvac_mode_settings\": [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\"\n ],\n \"current_climate_setting\": {\n \"display_name\": \"Manual Setting\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 25,\n \"heating_set_point_fahrenheit\": 77,\n \"hvac_mode_setting\": \"heat\",\n \"manual_override_allowed\": true\n },\n \"ecobee_metadata\": {\n \"device_name\": \"Living Room\",\n \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n },\n \"fallback_climate_preset_key\": \"eco\",\n \"fan_mode_setting\": \"auto\",\n \"has_direct_power\": true,\n \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\": false,\n \"is_fan_running\": false,\n \"is_heating\": false,\n \"is_temporary_manual_override_active\": false,\n \"manufacturer\": \"ecobee\",\n \"max_cooling_set_point_celsius\": 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\": 92,\n \"max_heating_set_point_celsius\": 26.11111111111111,\n \"max_heating_set_point_fahrenheit\": 79,\n \"min_cooling_set_point_celsius\": 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\": 65,\n \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\": 5,\n \"min_heating_set_point_celsius\": 7.222222222222222,\n \"min_heating_set_point_fahrenheit\": 45,\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Ecobee\"\n },\n \"name\": \"Living Room\",\n \"online\": true,\n \"relative_humidity\": 0.36,\n \"temperature_celsius\": 21.11111111111111,\n \"temperature_fahrenheit\": 70,\n \"temperature_threshold\": {\n \"lower_limit_celsius\": 16.66666666666667,\n \"lower_limit_fahrenheit\": 62,\n \"upper_limit_celsius\": 26.66666666666667,\n \"upper_limit_fahrenheit\": 80\n },\n \"thermostat_daily_programs\": [\n {\n \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"work\"\n },\n {\n \"starts_at_time\": \"18:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"22:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:01:25.455Z\"\n },\n {\n \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekend Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"08:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"23:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:02:19.952Z\"\n }\n ],\n \"thermostat_weekly_program\": null\n },\n \"warnings\": [],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->list(\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\n);\n\n// [\n [\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"active_climate_preset\" => [\n \"can_delete\" => true,\n \"can_edit\" => true,\n \"climate_preset_key\" => \"sleep\",\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n ],\n \"appearance\" => [\"name\" => \"Living Room\"],\n \"available_climate_presets\" => [\n [\n \"climate_preset_key\" => \"sleep\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Sleep\",\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"home\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Home\",\n \"display_name\" => \"Home\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"work\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Work\",\n \"display_name\" => \"Work\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n ],\n \"available_fan_mode_settings\" => [\"auto\", \"on\"],\n \"available_hvac_mode_settings\" => [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\",\n ],\n \"current_climate_setting\" => [\n \"display_name\" => \"Manual Setting\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 25,\n \"heating_set_point_fahrenheit\" => 77,\n \"hvac_mode_setting\" => \"heat\",\n \"manual_override_allowed\" => true,\n ],\n \"ecobee_metadata\" => [\n \"device_name\" => \"Living Room\",\n \"ecobee_device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n ],\n \"fallback_climate_preset_key\" => \"eco\",\n \"fan_mode_setting\" => \"auto\",\n \"has_direct_power\" => true,\n \"image_alt_text\" => \"Ecobee 3 Lite Thermostat\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\" => false,\n \"is_fan_running\" => false,\n \"is_heating\" => false,\n \"is_temporary_manual_override_active\" => false,\n \"manufacturer\" => \"ecobee\",\n \"max_cooling_set_point_celsius\" => 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\" => 92,\n \"max_heating_set_point_celsius\" => 26.11111111111111,\n \"max_heating_set_point_fahrenheit\" => 79,\n \"min_cooling_set_point_celsius\" => 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\" => 65,\n \"min_heating_cooling_delta_celsius\" => 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\" => 5,\n \"min_heating_set_point_celsius\" => 7.222222222222222,\n \"min_heating_set_point_fahrenheit\" => 45,\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Ecobee\",\n ],\n \"name\" => \"Living Room\",\n \"online\" => true,\n \"relative_humidity\" => 0.36,\n \"temperature_celsius\" => 21.11111111111111,\n \"temperature_fahrenheit\" => 70,\n \"temperature_threshold\" => [\n \"lower_limit_celsius\" => 16.66666666666667,\n \"lower_limit_fahrenheit\" => 62,\n \"upper_limit_celsius\" => 26.66666666666667,\n \"upper_limit_fahrenheit\" => 80,\n ],\n \"thermostat_daily_programs\" => [\n [\n \"thermostat_daily_program_id\" =>\n \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"07:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"09:00:00\",\n \"climate_preset_key\" => \"work\",\n ],\n [\n \"starts_at_time\" => \"18:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"22:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:01:25.455Z\",\n ],\n [\n \"thermostat_daily_program_id\" =>\n \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekend Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"08:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"23:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:02:19.952Z\",\n ],\n ],\n \"thermostat_weekly_program\" => null,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices list --connected_account_id \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\" --limit 50\n\n# [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]" } ] } }, "/devices/list_device_providers": { "get": { "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "operationId": "devicesListDeviceProvidersGet", "parameters": [ { "in": "query", "name": "provider_category", "schema": { "description": "Category for which you want to list providers.", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras", "connectors" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device_providers": { "items": { "$ref": "#/components/schemas/device_provider" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "device_providers", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/devices/list_device_providers", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices" ], "x-fern-sdk-method-name": "list_device_providers", "x-fern-sdk-return-value": "device_providers", "x-response-key": "device_providers", "x-title": "List Device Providers" }, "post": { "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "operationId": "devicesListDeviceProvidersPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "provider_category": { "description": "Category for which you want to list providers.", "enum": [ "stable", "consumer_smartlocks", "beta", "thermostats", "noise_sensors", "access_control_systems", "cameras", "connectors" ], "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device_providers": { "items": { "$ref": "#/components/schemas/device_provider" }, "type": "array" } }, "required": [ "device_providers" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Device Providers", "tags": [ "/devices" ], "x-response-key": "device_providers", "x-title": "List Device Providers", "x-mint": { "href": "/api/devices/list_device_providers" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.listDeviceProviders();\n\n/*\n[\n {\n \"can_program_online_access_codes\": true,\n \"can_remotely_unlock\": true,\n \"device_provider_name\": \"akiles\",\n \"display_name\": \"Akiles\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/list_device_providers\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"device_providers\": [\n# {\n# \"can_program_online_access_codes\": true,\n# \"can_remotely_unlock\": true,\n# \"device_provider_name\": \"akiles\",\n# \"display_name\": \"Akiles\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.devices.list_device_providers()\n\n# [\n DeviceProvider(\n can_program_online_access_codes=true,\n can_remotely_unlock=true,\n device_provider_name=\"akiles\",\n display_name=\"Akiles\",\n image_url=\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n provider_categories=[\"stable\", \"consumer_smartlocks\"],\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.devices.list_device_providers()\n\n# => [\n {\n \"can_program_online_access_codes\" => true,\n \"can_remotely_unlock\" => true,\n \"device_provider_name\" => \"akiles\",\n \"display_name\" => \"Akiles\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\" => %w[stable consumer_smartlocks],\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->list_device_providers();\n\n// [\n [\n \"can_program_online_access_codes\" => true,\n \"can_remotely_unlock\" => true,\n \"device_provider_name\" => \"akiles\",\n \"display_name\" => \"Akiles\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\" => [\"stable\", \"consumer_smartlocks\"],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices list-device-providers\n\n# [\n# {\n# \"can_program_online_access_codes\": true,\n# \"can_remotely_unlock\": true,\n# \"device_provider_name\": \"akiles\",\n# \"display_name\": \"Akiles\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" } ] } }, "/devices/report_provider_metadata": { "post": { "description": "Updates provider-specific metadata for devices.", "operationId": "devicesReportProviderMetadataPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "devices": { "description": "Array of devices with provider metadata to update", "items": { "properties": { "device_id": { "description": "ID of the device to update", "format": "uuid", "type": "string" }, "omnitec_metadata": { "description": "Omnitec-specific metadata to update", "properties": { "time_zone": { "description": "IANA timezone for the Omnitec device", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis" ], "type": "string" } }, "required": [ "time_zone" ], "type": "object" }, "schlage_metadata": { "description": "Schlage-specific metadata to update", "properties": { "time_zone": { "description": "IANA timezone for the Schlage device", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis" ], "type": "string" } }, "required": [ "time_zone" ], "type": "object" }, "ultraloq_metadata": { "description": "Ultraloq-specific metadata to update", "properties": { "time_zone": { "description": "IANA timezone for the Ultraloq device", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis" ], "type": "string" } }, "required": [ "time_zone" ], "type": "object" } }, "required": [ "device_id" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "devices" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Report Provider Metadata", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Report Provider Metadata", "x-mint": { "href": "/api/devices/report_provider_metadata" } } }, "/devices/simulate/connect": { "post": { "description": "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).", "operationId": "devicesSimulateConnectPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that you want to simulate connecting to Seam.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Device Connection", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Device Connection", "x-mint": { "href": "/api/devices/simulate/connect" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.simulate.connect({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->simulate->connect(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices simulate connect --device_id \"5d703d4f-523f-42af-9439-618415ca651f\"\n\n# {}" } ] } }, "/devices/simulate/connect_to_hub": { "post": { "description": "Simulates bringing the Wi‑Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the `hub_disconnected` error on the device.", "operationId": "devicesSimulateConnectToHubPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device whose hub you want to reconnect.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Hub Connection", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Hub Connection", "x-mint": { "href": "/api/devices/simulate/connect_to_hub" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.simulate.connectToHub({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect_to_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->simulate->connect_to_hub(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices simulate connect-to-hub --device_id \"5d703d4f-523f-42af-9439-618415ca651f\"\n\n# {}" } ] } }, "/devices/simulate/disconnect": { "post": { "description": "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).", "operationId": "devicesSimulateDisconnectPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that you want to simulate disconnecting from Seam.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Device Disconnection", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Device Disconnection", "x-mint": { "href": "/api/devices/simulate/disconnect" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.simulate.disconnect({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->simulate->disconnect(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices simulate disconnect --device_id \"a60686b8-f401-452d-9f67-53d139cf6160\"\n\n# {}" } ] } }, "/devices/simulate/disconnect_from_hub": { "post": { "description": "Simulates taking the Wi‑Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the `hub_disconnected` error on the device, or mark the\nIglooHome bridge offline in sandbox.", "operationId": "devicesSimulateDisconnectFromHubPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device whose hub you want to disconnect.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Hub Disconnection", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Hub Disconnection", "x-mint": { "href": "/api/devices/simulate/disconnect_from_hub" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.simulate.disconnectFromHub({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->simulate->disconnect_from_hub(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices simulate disconnect-from-hub --device_id \"a60686b8-f401-452d-9f67-53d139cf6160\"\n\n# {}" } ] } }, "/devices/simulate/paid_subscription": { "post": { "description": "Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).\nSend `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.\nThe actual device error is created/cleared by the poller after this state change.", "operationId": "devicesSimulatePaidSubscriptionPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "format": "uuid", "type": "string" }, "is_expired": { "type": "boolean" } }, "required": [ "device_id", "is_expired" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Paid Subscription", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Paid Subscription", "x-mint": { "href": "/api/devices/simulate/paid_subscription" } } }, "/devices/simulate/remove": { "post": { "description": "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).", "operationId": "devicesSimulateRemovePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that you want to simulate removing from Seam.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Simulate Device Removal", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Simulate Device Removal", "x-mint": { "href": "/api/devices/simulate/remove" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.simulate.remove({\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->simulate->remove(\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices simulate remove --device_id \"46757795-11f7-446a-a6cb-779e9f039d7c\"\n\n# {}" } ] } }, "/devices/unmanaged/get": { "get": { "description": "Returns a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesUnmanagedGetGet", "parameters": [ { "in": "query", "name": "device_id", "schema": { "description": "ID of the unmanaged device that you want to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "name", "schema": { "description": "Name of the unmanaged device that you want to get.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/unmanaged_device" }, "ok": { "type": "boolean" } }, "required": [ "device", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/devices/unmanaged/get", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices", "unmanaged" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device", "x-response-key": "device", "x-title": "Get an Unmanaged Device" }, "post": { "description": "Returns a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.", "operationId": "devicesUnmanagedGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the unmanaged device that you want to get.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the unmanaged device that you want to get.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/unmanaged_device" } }, "required": [ "device" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get an Unmanaged Device", "tags": [ "/devices" ], "x-response-key": "device", "x-title": "Get an Unmanaged Device", "x-mint": { "href": "/api/devices/unmanaged/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.unmanaged.get({\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n});\n\n/*\n{\n \"can_program_offline_access_codes\": false,\n \"can_program_online_access_codes\": true,\n \"can_remotely_lock\": true,\n \"can_remotely_unlock\": true,\n \"can_simulate_connection\": false,\n \"can_simulate_disconnection\": true,\n \"can_simulate_removal\": true,\n \"capabilities_supported\": [\n \"access_code\",\n \"lock\"\n ],\n \"connected_account_id\": \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\": \"2025-06-16T16:54:17.946342Z\",\n \"device_id\": \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n \"device_type\": \"schlage_lock\",\n \"errors\": [],\n \"is_managed\": false,\n \"location\": {\n \"location_name\": \"Front Door\",\n \"timezone\": \"America/New_York\"\n },\n \"properties\": {\n \"accessory_keypad\": {\n \"battery\": {\n \"level\": 1\n },\n \"is_connected\": true\n },\n \"battery\": {\n \"level\": 1,\n \"status\": \"full\"\n },\n \"battery_level\": 1,\n \"image_alt_text\": \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n \"manufacturer\": \"schlage\",\n \"model\": {\n \"accessory_keypad_supported\": true,\n \"can_connect_accessory_keypad\": true,\n \"display_name\": \"Front Door\",\n \"has_built_in_keypad\": false,\n \"manufacturer_display_name\": \"Schlage\",\n \"offline_access_codes_supported\": false,\n \"online_access_codes_supported\": true\n },\n \"name\": \"My Unmanaged Device\",\n \"offline_access_codes_enabled\": false,\n \"online\": true,\n \"online_access_codes_enabled\": true\n },\n \"warnings\": [],\n \"workspace_id\": \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"My Unmanaged Device\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->unmanaged->get(\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n);\n\n// [\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => [\"access_code\", \"lock\"],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => [\n \"location_name\" => \"Front Door\",\n \"timezone\" => \"America/New_York\",\n ],\n \"properties\" => [\n \"accessory_keypad\" => [\n \"battery\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n \"manufacturer\" => \"schlage\",\n \"model\" => [\n \"accessory_keypad_supported\" => true,\n \"can_connect_accessory_keypad\" => true,\n \"display_name\" => \"Front Door\",\n \"has_built_in_keypad\" => false,\n \"manufacturer_display_name\" => \"Schlage\",\n \"offline_access_codes_supported\" => false,\n \"online_access_codes_supported\" => true,\n ],\n \"name\" => \"My Unmanaged Device\",\n \"offline_access_codes_enabled\" => false,\n \"online\" => true,\n \"online_access_codes_enabled\" => true,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices unmanaged get --device_id \"9f871e41-0ce4-4825-8d99-9653df4cd525\"\n\n# {\n# \"can_program_offline_access_codes\": false,\n# \"can_program_online_access_codes\": true,\n# \"can_remotely_lock\": true,\n# \"can_remotely_unlock\": true,\n# \"can_simulate_connection\": false,\n# \"can_simulate_disconnection\": true,\n# \"can_simulate_removal\": true,\n# \"capabilities_supported\": [\n# \"access_code\",\n# \"lock\"\n# ],\n# \"connected_account_id\": \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n# \"created_at\": \"2025-06-16T16:54:17.946342Z\",\n# \"device_id\": \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n# \"device_type\": \"schlage_lock\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"location\": {\n# \"location_name\": \"Front Door\",\n# \"timezone\": \"America/New_York\"\n# },\n# \"properties\": {\n# \"accessory_keypad\": {\n# \"battery\": {\n# \"level\": 1\n# },\n# \"is_connected\": true\n# },\n# \"battery\": {\n# \"level\": 1,\n# \"status\": \"full\"\n# },\n# \"battery_level\": 1,\n# \"image_alt_text\": \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n# \"manufacturer\": \"schlage\",\n# \"model\": {\n# \"accessory_keypad_supported\": true,\n# \"can_connect_accessory_keypad\": true,\n# \"display_name\": \"Front Door\",\n# \"has_built_in_keypad\": false,\n# \"manufacturer_display_name\": \"Schlage\",\n# \"offline_access_codes_supported\": false,\n# \"online_access_codes_supported\": true\n# },\n# \"name\": \"My Unmanaged Device\",\n# \"offline_access_codes_enabled\": false,\n# \"online\": true,\n# \"online_access_codes_enabled\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"\n# }" } ] } }, "/devices/unmanaged/list": { "get": { "description": "Returns a list of all [unmanaged devices](/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_ids", "schema": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_type", "schema": { "description": "Device type for which you want to list devices.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] } }, { "in": "query", "name": "device_types", "schema": { "description": "Array of device types for which you want to list devices.", "items": { "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "type": "array" } }, { "in": "query", "name": "manufacturer", "schema": { "description": "Manufacturer for which you want to list devices.", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi", "slack" ], "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "unstable_location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 22900, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/unmanaged_device" }, "type": "array" }, "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "devices", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/devices/unmanaged/list", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices", "unmanaged" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Unmanaged Devices" }, "post": { "description": "Returns a list of all [unmanaged devices](/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_ids": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_before": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" }, "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list devices.", "type": "string" }, "device_ids": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_type": { "description": "Device type for which you want to list devices.", "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "device_types": { "description": "Array of device types for which you want to list devices.", "items": { "oneOf": [ { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, { "description": "Device type for keys.\n ", "enum": [ "keynest_key" ], "type": "string" }, { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, { "description": "Device type for phones.\n ", "enum": [ "ios_phone", "android_phone" ], "type": "string" }, { "description": "Device type for cameras.", "enum": [ "ring_camera" ], "type": "string" } ] }, "type": "array" }, "limit": { "default": 22900, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" }, "manufacturer": { "description": "Manufacturer for which you want to list devices.", "enum": [ "akuvox", "august", "avigilon_alta", "brivo", "butterflymx", "doorking", "four_suites", "genie", "igloo", "keywe", "kwikset", "linear", "lockly", "nuki", "philia", "salto", "samsung", "schlage", "seam", "unknown", "wyze", "yale", "two_n", "ttlock", "igloohome", "controlbyweb", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "ecobee", "honeywell_resideo", "keynest", "korelock", "minut", "nest", "noiseaware", "sensi", "smartthings", "tado", "ultraloq", "ring", "ical", "lodgify", "hostaway", "guesty", "acuity_scheduling", "omnitec", "kisi", "slack" ], "type": "string" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" }, "unstable_location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/unmanaged_device" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/pagination" } }, "required": [ "devices", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "List Unmanaged Devices", "tags": [ "/devices" ], "x-response-key": "devices", "x-title": "List Unmanaged Devices", "x-mint": { "href": "/api/devices/unmanaged/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.unmanaged.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n});\n\n/*\n[\n {\n \"can_program_offline_access_codes\": false,\n \"can_program_online_access_codes\": true,\n \"can_remotely_lock\": true,\n \"can_remotely_unlock\": true,\n \"can_simulate_connection\": false,\n \"can_simulate_disconnection\": true,\n \"can_simulate_removal\": true,\n \"capabilities_supported\": [\n \"access_code\",\n \"lock\"\n ],\n \"connected_account_id\": \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\": \"2025-06-16T16:54:17.946342Z\",\n \"device_id\": \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n \"device_type\": \"schlage_lock\",\n \"errors\": [],\n \"is_managed\": false,\n \"location\": {\n \"location_name\": \"Front Door\",\n \"timezone\": \"America/New_York\"\n },\n \"properties\": {\n \"accessory_keypad\": {\n \"battery\": {\n \"level\": 1\n },\n \"is_connected\": true\n },\n \"battery\": {\n \"level\": 1,\n \"status\": \"full\"\n },\n \"battery_level\": 1,\n \"image_alt_text\": \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n \"manufacturer\": \"schlage\",\n \"model\": {\n \"accessory_keypad_supported\": true,\n \"can_connect_accessory_keypad\": true,\n \"display_name\": \"Front Door\",\n \"has_built_in_keypad\": false,\n \"manufacturer_display_name\": \"Schlage\",\n \"offline_access_codes_supported\": false,\n \"online_access_codes_supported\": true\n },\n \"name\": \"Front Door\",\n \"offline_access_codes_enabled\": false,\n \"online\": true,\n \"online_access_codes_enabled\": true\n },\n \"warnings\": [],\n \"workspace_id\": \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"Front Door\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->unmanaged->list(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n);\n\n// [\n [\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => [\"access_code\", \"lock\"],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => [\n \"location_name\" => \"Front Door\",\n \"timezone\" => \"America/New_York\",\n ],\n \"properties\" => [\n \"accessory_keypad\" => [\n \"battery\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n \"manufacturer\" => \"schlage\",\n \"model\" => [\n \"accessory_keypad_supported\" => true,\n \"can_connect_accessory_keypad\" => true,\n \"display_name\" => \"Front Door\",\n \"has_built_in_keypad\" => false,\n \"manufacturer_display_name\" => \"Schlage\",\n \"offline_access_codes_supported\" => false,\n \"online_access_codes_supported\" => true,\n ],\n \"name\" => \"Front Door\",\n \"offline_access_codes_enabled\" => false,\n \"online\" => true,\n \"online_access_codes_enabled\" => true,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices unmanaged list --customer_ids [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"]\n\n# [\n# {\n# \"can_program_offline_access_codes\": false,\n# \"can_program_online_access_codes\": true,\n# \"can_remotely_lock\": true,\n# \"can_remotely_unlock\": true,\n# \"can_simulate_connection\": false,\n# \"can_simulate_disconnection\": true,\n# \"can_simulate_removal\": true,\n# \"capabilities_supported\": [\n# \"access_code\",\n# \"lock\"\n# ],\n# \"connected_account_id\": \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n# \"created_at\": \"2025-06-16T16:54:17.946342Z\",\n# \"device_id\": \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n# \"device_type\": \"schlage_lock\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"location\": {\n# \"location_name\": \"Front Door\",\n# \"timezone\": \"America/New_York\"\n# },\n# \"properties\": {\n# \"accessory_keypad\": {\n# \"battery\": {\n# \"level\": 1\n# },\n# \"is_connected\": true\n# },\n# \"battery\": {\n# \"level\": 1,\n# \"status\": \"full\"\n# },\n# \"battery_level\": 1,\n# \"image_alt_text\": \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n# \"manufacturer\": \"schlage\",\n# \"model\": {\n# \"accessory_keypad_supported\": true,\n# \"can_connect_accessory_keypad\": true,\n# \"display_name\": \"Front Door\",\n# \"has_built_in_keypad\": false,\n# \"manufacturer_display_name\": \"Schlage\",\n# \"offline_access_codes_supported\": false,\n# \"online_access_codes_supported\": true\n# },\n# \"name\": \"Front Door\",\n# \"offline_access_codes_enabled\": false,\n# \"online\": true,\n# \"online_access_codes_enabled\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"\n# }\n# ]" } ] } }, "/devices/unmanaged/update": { "patch": { "description": "Updates a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.", "type": "object" }, "device_id": { "description": "ID of the unmanaged device that you want to update.", "format": "uuid", "type": "string" }, "is_managed": { "description": "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.", "enum": [ true ], "type": "boolean" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/devices/unmanaged/update", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices", "unmanaged" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Unmanaged Device" }, "post": { "description": "Updates a specified [unmanaged device](/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).", "operationId": "devicesUnmanagedUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.", "type": "object" }, "device_id": { "description": "ID of the unmanaged device that you want to update.", "format": "uuid", "type": "string" }, "is_managed": { "description": "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.", "enum": [ true ], "type": "boolean" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Update an Unmanaged Device", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Update an Unmanaged Device", "x-mint": { "href": "/api/devices/unmanaged/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.unmanaged.update({\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->unmanaged->update(\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices unmanaged update --device_id \"66c3adbf-a0e5-403a-8981-ec5286b5da76\" --is_managed true\n\n# {}" } ] } }, "/devices/update": { "patch": { "description": "Updates a specified [device](/core-concepts/devices).\n\nYou can add or change [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](/core-concepts/devices/managed-and-unmanaged-devices).", "operationId": "devicesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "backup_access_code_pool_enabled": { "description": "Indicates whether the device's [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.", "type": "boolean" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](/core-concepts/devices/filtering-devices-by-custom-metadata).", "type": "object" }, "device_id": { "description": "ID of the device that you want to update.", "format": "uuid", "type": "string" }, "is_managed": { "default": true, "description": "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.", "type": "boolean" }, "name": { "description": "Name for the device.", "nullable": true, "type": "string" }, "properties": { "properties": { "name": { "description": "Name for the device.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "summary": "/devices/update", "tags": [ "/devices" ], "x-fern-sdk-group-name": [ "devices" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Device" }, "post": { "description": "Updates a specified [device](/core-concepts/devices).\n\nYou can add or change [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](/core-concepts/devices/managed-and-unmanaged-devices).", "operationId": "devicesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "backup_access_code_pool_enabled": { "description": "Indicates whether the device's [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.", "type": "boolean" }, "custom_metadata": { "additionalProperties": { "nullable": true, "oneOf": [ { "maxLength": 500, "type": "string" }, { "type": "boolean" } ] }, "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](/core-concepts/devices/filtering-devices-by-custom-metadata).", "type": "object" }, "device_id": { "description": "ID of the device that you want to update.", "format": "uuid", "type": "string" }, "is_managed": { "default": true, "description": "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.", "type": "boolean" }, "name": { "description": "Name for the device.", "nullable": true, "type": "string" }, "properties": { "properties": { "name": { "description": "Name for the device.", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] } ], "summary": "Update a Device", "tags": [ "/devices" ], "x-response-key": null, "x-title": "Update a Device", "x-mint": { "href": "/api/devices/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.devices.update({\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/devices/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->devices->update(\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam devices update --device_id \"ccfab465-4838-4ff3-af62-97c78e8bf44b\" --name \"My Updated Device\" --is_managed true --custom_metadata {\"id\":\"internalId1\"}\n\n# {}" } ] } }, "/events/get": { "get": { "description": "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.", "operationId": "eventsGetGet", "parameters": [ { "in": "query", "name": "event_id", "schema": { "description": "Unique identifier for the event that you want to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "event_type", "schema": { "description": "Type of the event that you want to get.", "type": "string" } }, { "in": "query", "name": "device_id", "schema": { "description": "Unique identifier for the device that triggered the event that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "event": { "$ref": "#/components/schemas/event" }, "message": { "type": "string" }, "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/events/get", "tags": [ "/events" ], "x-fern-sdk-group-name": [ "events" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "event", "x-response-key": "event", "x-title": "Get an Event" }, "post": { "description": "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.", "operationId": "eventsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "Unique identifier for the device that triggered the event that you want to get.", "format": "uuid", "type": "string" }, "event_id": { "description": "Unique identifier for the event that you want to get.", "format": "uuid", "type": "string" }, "event_type": { "description": "Type of the event that you want to get.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "event": { "$ref": "#/components/schemas/event" } }, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Get an Event", "tags": [ "/events" ], "x-response-key": "event", "x-title": "Get an Event", "x-mint": { "href": "/api/events/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.events.get({ event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\" });\n\n/*\n{\n \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n \"device_id\": \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\": \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n \"event_type\": \"device.connected\",\n \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/events/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->events->get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\");\n\n// [\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam events get --event_id \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\"\n\n# {\n# \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n# \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n# \"device_id\": \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n# \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n# \"event_id\": \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n# \"event_type\": \"device.connected\",\n# \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n# }" } ] } }, "/events/list": { "get": { "description": "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.", "operationId": "eventsListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list events.", "type": "string" } }, { "in": "query", "name": "unstable_offset", "schema": { "description": "Offset for the events that you want to list.", "format": "float", "type": "number" } }, { "in": "query", "name": "since", "schema": { "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.", "type": "string" } }, { "in": "query", "name": "between", "schema": { "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.", "items": { "oneOf": [ { "type": "string" }, { "format": "date-time", "type": "string" } ] }, "maxItems": 2, "minItems": 2, "type": "array" } }, { "in": "query", "name": "device_id", "schema": { "description": "ID of the device for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "IDs of the devices for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "acs_system_id", "schema": { "description": "ID of the access system for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_system_ids", "schema": { "description": "IDs of the access systems for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "access_code_id", "schema": { "description": "ID of the access code for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_code_ids", "schema": { "description": "IDs of the access codes for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "event_type", "schema": { "description": "Type of the events that you want to list.", "enum": [ "access_code.created", "access_code.changed", "access_code.name_changed", "access_code.code_changed", "access_code.time_frame_changed", "access_code.mutations_requested", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "type": "string" } }, { "in": "query", "name": "event_types", "schema": { "description": "Types of the events that you want to list.", "items": { "enum": [ "access_code.created", "access_code.changed", "access_code.name_changed", "access_code.code_changed", "access_code.time_frame_changed", "access_code.mutations_requested", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of events to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "event_ids", "schema": { "description": "IDs of the events that you want to list.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "acs_entrance_id", "schema": { "description": "ID of the ACS entrance for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_user_id", "schema": { "description": "ID of the ACS user for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_id", "schema": { "description": "ID of the access grant for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_grant_ids", "schema": { "description": "IDs of the access grants for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" } }, { "in": "query", "name": "access_method_id", "schema": { "description": "ID of the access method for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "access_method_ids", "schema": { "description": "IDs of the access methods for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" } }, { "in": "query", "name": "acs_credential_id", "schema": { "description": "ID of the ACS credential for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "space_ids", "schema": { "description": "IDs of the spaces for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" } }, { "in": "query", "name": "acs_access_group_id", "schema": { "description": "ID of the ACS access group for which you want to list events.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_encoder_id", "schema": { "description": "ID of the ACS encoder for which you want to list events.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "$ref": "#/components/schemas/event" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "events", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/events/list", "tags": [ "/events" ], "x-fern-sdk-group-name": [ "events" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "events", "x-response-key": "events", "x-title": "List Events" }, "post": { "description": "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.", "operationId": "eventsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "access_code_id": { "description": "ID of the access code for which you want to list events.", "format": "uuid", "type": "string" }, "access_code_ids": { "description": "IDs of the access codes for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "access_grant_id": { "description": "ID of the access grant for which you want to list events.", "format": "uuid", "type": "string" }, "access_grant_ids": { "description": "IDs of the access grants for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" }, "access_method_id": { "description": "ID of the access method for which you want to list events.", "format": "uuid", "type": "string" }, "access_method_ids": { "description": "IDs of the access methods for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" }, "acs_access_group_id": { "description": "ID of the ACS access group for which you want to list events.", "format": "uuid", "type": "string" }, "acs_credential_id": { "description": "ID of the ACS credential for which you want to list events.", "format": "uuid", "type": "string" }, "acs_encoder_id": { "description": "ID of the ACS encoder for which you want to list events.", "format": "uuid", "type": "string" }, "acs_entrance_id": { "description": "ID of the ACS entrance for which you want to list events.", "format": "uuid", "type": "string" }, "acs_system_id": { "description": "ID of the access system for which you want to list events.", "format": "uuid", "type": "string" }, "acs_system_ids": { "description": "IDs of the access systems for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "acs_user_id": { "description": "ID of the ACS user for which you want to list events.", "format": "uuid", "type": "string" }, "between": { "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.", "items": { "oneOf": [ { "type": "string" }, { "format": "date-time", "type": "string" } ] }, "maxItems": 2, "minItems": 2, "type": "array" }, "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list events.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list events.", "format": "uuid", "type": "string" }, "customer_key": { "description": "Customer key for which you want to list events.", "type": "string" }, "device_id": { "description": "ID of the device for which you want to list events.", "format": "uuid", "type": "string" }, "device_ids": { "description": "IDs of the devices for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "event_ids": { "description": "IDs of the events that you want to list.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "event_type": { "description": "Type of the events that you want to list.", "enum": [ "access_code.created", "access_code.changed", "access_code.name_changed", "access_code.code_changed", "access_code.time_frame_changed", "access_code.mutations_requested", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "type": "string" }, "event_types": { "description": "Types of the events that you want to list.", "items": { "enum": [ "access_code.created", "access_code.changed", "access_code.name_changed", "access_code.code_changed", "access_code.time_frame_changed", "access_code.mutations_requested", "access_code.scheduled_on_device", "access_code.set_on_device", "access_code.removed_from_device", "access_code.delay_in_setting_on_device", "access_code.failed_to_set_on_device", "access_code.deleted", "access_code.delay_in_removing_from_device", "access_code.failed_to_remove_from_device", "access_code.modified_external_to_seam", "access_code.deleted_external_to_seam", "access_code.backup_access_code_pulled", "access_code.unmanaged.converted_to_managed", "access_code.unmanaged.failed_to_convert_to_managed", "access_code.unmanaged.created", "access_code.unmanaged.removed", "access_grant.created", "access_grant.deleted", "access_grant.access_granted_to_all_doors", "access_grant.access_granted_to_door", "access_grant.access_to_door_lost", "access_grant.access_times_changed", "access_grant.could_not_create_requested_access_methods", "access_method.issued", "access_method.revoked", "access_method.card_encoding_required", "access_method.deleted", "access_method.reissued", "access_method.created", "acs_system.connected", "acs_system.added", "acs_system.disconnected", "acs_credential.deleted", "acs_credential.issued", "acs_credential.reissued", "acs_credential.invalidated", "acs_user.created", "acs_user.deleted", "acs_encoder.added", "acs_encoder.removed", "acs_access_group.deleted", "acs_entrance.added", "acs_entrance.removed", "client_session.deleted", "connected_account.connected", "connected_account.created", "connected_account.successful_login", "connected_account.disconnected", "connected_account.completed_first_sync", "connected_account.deleted", "connected_account.completed_first_sync_after_reconnection", "connected_account.reauthorization_requested", "action_attempt.lock_door.succeeded", "action_attempt.lock_door.failed", "action_attempt.unlock_door.succeeded", "action_attempt.unlock_door.failed", "action_attempt.simulate_keypad_code_entry.succeeded", "action_attempt.simulate_keypad_code_entry.failed", "action_attempt.simulate_manual_lock_via_keypad.succeeded", "action_attempt.simulate_manual_lock_via_keypad.failed", "connect_webview.login_succeeded", "connect_webview.login_failed", "device.connected", "device.added", "device.converted_to_unmanaged", "device.unmanaged.converted_to_managed", "device.unmanaged.connected", "device.disconnected", "device.unmanaged.disconnected", "device.tampered", "device.low_battery", "device.battery_status_changed", "device.removed", "device.deleted", "device.third_party_integration_detected", "device.third_party_integration_no_longer_detected", "device.salto.privacy_mode_activated", "device.salto.privacy_mode_deactivated", "device.connection_became_flaky", "device.connection_stabilized", "device.error.subscription_required", "device.error.subscription_required.resolved", "device.accessory_keypad_connected", "device.accessory_keypad_disconnected", "noise_sensor.noise_threshold_triggered", "lock.locked", "lock.unlocked", "lock.access_denied", "thermostat.climate_preset_activated", "thermostat.manually_adjusted", "thermostat.temperature_threshold_exceeded", "thermostat.temperature_threshold_no_longer_exceeded", "thermostat.temperature_reached_set_point", "thermostat.temperature_changed", "device.name_changed", "camera.activated", "device.doorbell_rang", "enrollment_automation.deleted", "phone.deactivated", "space.device_membership_changed", "space.created", "space.deleted" ], "type": "string" }, "type": "array" }, "limit": { "default": 500, "description": "Numerical limit on the number of events to return.", "format": "float", "type": "number" }, "since": { "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.", "type": "string" }, "space_id": { "description": "ID of the space for which you want to list events.", "format": "uuid", "type": "string" }, "space_ids": { "description": "IDs of the spaces for which you want to list events.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "type": "array" }, "unstable_offset": { "description": "Offset for the events that you want to list.", "format": "float", "type": "number" }, "user_identity_id": { "description": "ID of the user identity for which you want to list events.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "$ref": "#/components/schemas/event" }, "type": "array" } }, "required": [ "events" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "List Events", "tags": [ "/events" ], "x-response-key": "events", "x-title": "List Events", "x-mint": { "href": "/api/events/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.events.list({\n device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n since: \"2025-05-15T00:00:00.000Z\",\n limit: 10,\n});\n\n/*\n[\n {\n \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n \"device_id\": \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\": \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"event_type\": \"device.connected\",\n \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/events/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->events->list(\n device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n since: \"2025-05-15T00:00:00.000Z\",\n limit: 10,\n);\n\n// [\n [\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam events list --device_id \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\" --since \"2025-05-15T00:00:00.000Z\" --limit 10\n\n# [\n# {\n# \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n# \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n# \"device_id\": \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n# \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n# \"event_id\": \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"event_type\": \"device.connected\",\n# \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n# }\n# ]" } ] } }, "/instant_keys/delete": { "delete": { "description": "Deletes a specified [Instant Key](/capability-guides/instant-keys).", "operationId": "instantKeysDeleteDelete", "parameters": [ { "in": "query", "name": "instant_key_id", "required": true, "schema": { "description": "ID of the Instant Key that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/instant_keys/delete", "tags": [], "x-fern-sdk-group-name": [ "instant_keys" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete an Instant Key" }, "post": { "description": "Deletes a specified [Instant Key](/capability-guides/instant-keys).", "operationId": "instantKeysDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "instant_key_id": { "description": "ID of the Instant Key that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "instant_key_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete an Instant Key", "tags": [], "x-response-key": null, "x-title": "Delete an Instant Key", "x-mint": { "href": "/api/instant_keys/delete" } } }, "/instant_keys/get": { "get": { "description": "Gets an [instant key](/capability-guides/instant-keys).", "operationId": "instantKeysGetGet", "parameters": [ { "in": "query", "name": "instant_key_id", "schema": { "description": "ID of the instant key to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "instant_key_url", "schema": { "description": "URL of the instant key to get.", "format": "uri", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" }, "ok": { "type": "boolean" } }, "required": [ "instant_key", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/instant_keys/get", "tags": [], "x-fern-sdk-group-name": [ "instant_keys" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "instant_key", "x-response-key": "instant_key", "x-title": "Get an Instant Key" }, "post": { "description": "Gets an [instant key](/capability-guides/instant-keys).", "operationId": "instantKeysGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "instant_key_id": { "description": "ID of the instant key to get.", "format": "uuid", "type": "string" }, "instant_key_url": { "description": "URL of the instant key to get.", "format": "uri", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" } }, "required": [ "instant_key" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get an Instant Key", "tags": [], "x-response-key": "instant_key", "x-title": "Get an Instant Key", "x-mint": { "href": "/api/instant_keys/get" } } }, "/instant_keys/list": { "get": { "description": "Returns a list of all [instant keys](/capability-guides/instant-keys).", "operationId": "instantKeysListGet", "parameters": [ { "in": "query", "name": "user_identity_id", "schema": { "description": "ID of the user identity by which you want to filter the list of Instant Keys.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "instant_keys": { "items": { "$ref": "#/components/schemas/instant_key" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "instant_keys", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/instant_keys/list", "tags": [], "x-fern-sdk-group-name": [ "instant_keys" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "instant_keys", "x-response-key": "instant_keys", "x-title": "List Instant Keys" }, "post": { "description": "Returns a list of all [instant keys](/capability-guides/instant-keys).", "operationId": "instantKeysListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity by which you want to filter the list of Instant Keys.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "instant_keys": { "items": { "$ref": "#/components/schemas/instant_key" }, "type": "array" } }, "required": [ "instant_keys" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Instant Keys", "tags": [], "x-response-key": "instant_keys", "x-title": "List Instant Keys", "x-mint": { "href": "/api/instant_keys/list" } } }, "/locks/configure_auto_lock": { "post": { "description": "Configures the auto-lock setting for a specified [lock](/low-level-apis/smart-locks).", "operationId": "locksConfigureAutoLockPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auto_lock_delay_seconds": { "description": "Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.", "format": "float", "maximum": 60, "minimum": 1, "type": "number" }, "auto_lock_enabled": { "description": "Whether to enable or disable auto-lock.", "type": "boolean" }, "device_id": { "description": "ID of the lock for which you want to configure the auto-lock.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "auto_lock_enabled" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "CONFIGURE_AUTO_LOCK" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Configure Auto-Lock", "tags": [ "/locks" ], "x-action-attempt-type": "CONFIGURE_AUTO_LOCK", "x-response-key": "action_attempt", "x-title": "Configure Auto-Lock", "x-mint": { "href": "/api/locks/configure_auto_lock" } } }, "/locks/get": { "get": { "description": "Deprecated. Use `/devices/get` instead.\n\nReturns a specified [lock](/low-level-apis/smart-locks).", "operationId": "locksGetGet", "parameters": [ { "in": "query", "name": "device_id", "schema": { "description": "ID of the lock that you want to get.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "name", "schema": { "description": "Name of the lock that you want to get.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/device" }, "lock": { "$ref": "#/components/schemas/device" }, "ok": { "type": "boolean" } }, "required": [ "lock", "device", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/locks/get", "tags": [ "/locks" ], "x-fern-sdk-group-name": [ "locks" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device", "x-response-key": "device", "x-title": "Get a Lock", "deprecated": true }, "post": { "description": "Deprecated. Use `/devices/get` instead.\n\nReturns a specified [lock](/low-level-apis/smart-locks).", "operationId": "locksGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the lock that you want to get.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the lock that you want to get.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "device": { "$ref": "#/components/schemas/device" } }, "required": [ "device" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Lock", "tags": [ "/locks" ], "x-response-key": "device", "x-title": "Get a Lock", "x-mint": { "href": "/api/locks/get" }, "deprecated": true } }, "/locks/list": { "get": { "description": "Returns a list of all [locks](/low-level-apis/smart-locks).", "operationId": "locksListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_ids", "schema": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_type", "schema": { "description": "Device type of the locks that you want to list.", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" } }, { "in": "query", "name": "device_types", "schema": { "description": "Device types of the locks that you want to list.", "items": { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "manufacturer", "schema": { "description": "Manufacturer of the locks that you want to list.", "enum": [ "akuvox", "august", "brivo", "butterflymx", "avigilon_alta", "doorking", "genie", "igloo", "linear", "lockly", "kwikset", "nuki", "salto", "schlage", "seam", "wyze", "yale", "two_n", "controlbyweb", "ttlock", "igloohome", "four_suites", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "korelock", "smartthings", "ultraloq", "omnitec", "kisi" ], "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "unstable_location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "locks": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "locks", "devices", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/locks/list", "tags": [ "/locks" ], "x-fern-sdk-group-name": [ "locks" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Locks" }, "post": { "description": "Returns a list of all [locks](/low-level-apis/smart-locks).", "operationId": "locksListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_ids": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_before": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" }, "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list devices.", "type": "string" }, "device_ids": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_type": { "description": "Device type of the locks that you want to list.", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, "device_types": { "description": "Device types of the locks that you want to list.", "items": { "description": "Device type for smartlocks.\n ", "enum": [ "akuvox_lock", "august_lock", "brivo_access_point", "butterflymx_panel", "avigilon_alta_entry", "doorking_lock", "genie_door", "igloo_lock", "linear_lock", "lockly_lock", "kwikset_lock", "nuki_lock", "salto_lock", "schlage_lock", "smartthings_lock", "wyze_lock", "yale_lock", "two_n_intercom", "controlbyweb_device", "ttlock_lock", "igloohome_lock", "four_suites_door", "dormakaba_oracode_door", "tedee_lock", "akiles_lock", "ultraloq_lock", "keyincode_lock", "omnitec_lock", "kisi_lock" ], "type": "string" }, "type": "array" }, "limit": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" }, "manufacturer": { "description": "Manufacturer of the locks that you want to list.", "enum": [ "akuvox", "august", "brivo", "butterflymx", "avigilon_alta", "doorking", "genie", "igloo", "linear", "lockly", "kwikset", "nuki", "salto", "schlage", "seam", "wyze", "yale", "two_n", "controlbyweb", "ttlock", "igloohome", "four_suites", "dormakaba_oracode", "tedee", "keyincode", "kisi", "akiles", "korelock", "smartthings", "ultraloq", "omnitec", "kisi" ], "type": "string" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" }, "unstable_location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" } }, "required": [ "devices" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Locks", "tags": [ "/locks" ], "x-response-key": "devices", "x-title": "List Locks", "x-mint": { "href": "/api/locks/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.locks.list({ limit: 10 });\n\n/*\n[\n {\n \"can_hvac_cool\": true,\n \"can_hvac_heat\": true,\n \"can_hvac_heat_cool\": true,\n \"can_turn_off_hvac\": true,\n \"capabilities_supported\": [\n \"thermostat\"\n ],\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\": \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\": \"ecobee_thermostat\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"active_climate_preset\": {\n \"can_delete\": true,\n \"can_edit\": true,\n \"climate_preset_key\": \"sleep\",\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 17.77777777777778,\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true\n },\n \"appearance\": {\n \"name\": \"Living Room\"\n },\n \"available_climate_presets\": [\n {\n \"climate_preset_key\": \"sleep\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Sleep\",\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"home\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Home\",\n \"display_name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"work\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Work\",\n \"display_name\": \"Work\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n }\n ],\n \"available_fan_mode_settings\": [\n \"auto\",\n true\n ],\n \"available_hvac_mode_settings\": [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n false\n ],\n \"current_climate_setting\": {\n \"display_name\": \"Manual Setting\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 25,\n \"heating_set_point_fahrenheit\": 77,\n \"hvac_mode_setting\": \"heat\",\n \"manual_override_allowed\": true\n },\n \"ecobee_metadata\": {\n \"device_name\": \"Living Room\",\n \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n },\n \"fallback_climate_preset_key\": \"eco\",\n \"fan_mode_setting\": \"auto\",\n \"has_direct_power\": true,\n \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\": false,\n \"is_fan_running\": false,\n \"is_heating\": false,\n \"is_temporary_manual_override_active\": false,\n \"manufacturer\": \"ecobee\",\n \"max_cooling_set_point_celsius\": 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\": 92,\n \"max_heating_set_point_celsius\": 26.11111111111111,\n \"max_heating_set_point_fahrenheit\": 79,\n \"min_cooling_set_point_celsius\": 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\": 65,\n \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\": 5,\n \"min_heating_set_point_celsius\": 7.222222222222222,\n \"min_heating_set_point_fahrenheit\": 45,\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Ecobee\"\n },\n \"name\": \"Living Room\",\n \"online\": true,\n \"relative_humidity\": 0.36,\n \"temperature_celsius\": 21.11111111111111,\n \"temperature_fahrenheit\": 70,\n \"temperature_threshold\": {\n \"lower_limit_celsius\": 16.66666666666667,\n \"lower_limit_fahrenheit\": 62,\n \"upper_limit_celsius\": 26.66666666666667,\n \"upper_limit_fahrenheit\": 80\n },\n \"thermostat_daily_programs\": [\n {\n \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"work\"\n },\n {\n \"starts_at_time\": \"18:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"22:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:01:25.455Z\"\n },\n {\n \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekend Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"08:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"23:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:02:19.952Z\"\n }\n ],\n \"thermostat_weekly_program\": null\n },\n \"warnings\": [],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/locks/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: [\"auto\", true],\n available_hvac_mode_settings: [\"cool\", \"heat\", \"heat_cool\", false],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->locks->list(limit: 10);\n\n// [\n [\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"active_climate_preset\" => [\n \"can_delete\" => true,\n \"can_edit\" => true,\n \"climate_preset_key\" => \"sleep\",\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n ],\n \"appearance\" => [\"name\" => \"Living Room\"],\n \"available_climate_presets\" => [\n [\n \"climate_preset_key\" => \"sleep\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Sleep\",\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"home\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Home\",\n \"display_name\" => \"Home\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"work\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Work\",\n \"display_name\" => \"Work\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n ],\n \"available_fan_mode_settings\" => [\"auto\", true],\n \"available_hvac_mode_settings\" => [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n false,\n ],\n \"current_climate_setting\" => [\n \"display_name\" => \"Manual Setting\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 25,\n \"heating_set_point_fahrenheit\" => 77,\n \"hvac_mode_setting\" => \"heat\",\n \"manual_override_allowed\" => true,\n ],\n \"ecobee_metadata\" => [\n \"device_name\" => \"Living Room\",\n \"ecobee_device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n ],\n \"fallback_climate_preset_key\" => \"eco\",\n \"fan_mode_setting\" => \"auto\",\n \"has_direct_power\" => true,\n \"image_alt_text\" => \"Ecobee 3 Lite Thermostat\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\" => false,\n \"is_fan_running\" => false,\n \"is_heating\" => false,\n \"is_temporary_manual_override_active\" => false,\n \"manufacturer\" => \"ecobee\",\n \"max_cooling_set_point_celsius\" => 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\" => 92,\n \"max_heating_set_point_celsius\" => 26.11111111111111,\n \"max_heating_set_point_fahrenheit\" => 79,\n \"min_cooling_set_point_celsius\" => 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\" => 65,\n \"min_heating_cooling_delta_celsius\" => 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\" => 5,\n \"min_heating_set_point_celsius\" => 7.222222222222222,\n \"min_heating_set_point_fahrenheit\" => 45,\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Ecobee\",\n ],\n \"name\" => \"Living Room\",\n \"online\" => true,\n \"relative_humidity\" => 0.36,\n \"temperature_celsius\" => 21.11111111111111,\n \"temperature_fahrenheit\" => 70,\n \"temperature_threshold\" => [\n \"lower_limit_celsius\" => 16.66666666666667,\n \"lower_limit_fahrenheit\" => 62,\n \"upper_limit_celsius\" => 26.66666666666667,\n \"upper_limit_fahrenheit\" => 80,\n ],\n \"thermostat_daily_programs\" => [\n [\n \"thermostat_daily_program_id\" =>\n \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"07:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"09:00:00\",\n \"climate_preset_key\" => \"work\",\n ],\n [\n \"starts_at_time\" => \"18:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"22:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:01:25.455Z\",\n ],\n [\n \"thermostat_daily_program_id\" =>\n \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekend Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"08:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"23:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:02:19.952Z\",\n ],\n ],\n \"thermostat_weekly_program\" => null,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam locks list --limit 10\n\n# [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# true\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# false\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]" } ] } }, "/locks/lock_door": { "post": { "description": "Locks a [lock](/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](/low-level-apis/smart-locks/lock-and-unlock).", "operationId": "locksLockDoorPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the lock that you want to lock.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "LOCK_DOOR" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Lock a Lock", "tags": [ "/locks" ], "x-action-attempt-type": "LOCK_DOOR", "x-response-key": "action_attempt", "x-title": "Lock a Lock", "x-mint": { "href": "/api/locks/lock_door" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.locks.lockDoor({\n device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\",\n});\n\n/*\n{\n \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\": \"LOCK_DOOR\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/locks/lock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->locks->lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\");\n\n// [\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam locks lock-door --device_id \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\"\n\n# {\n# \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n# \"action_type\": \"LOCK_DOOR\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/locks/simulate/keypad_code_entry": { "post": { "description": "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).", "operationId": "locksSimulateKeypadCodeEntryPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "Code that you want to simulate entering on a keypad.", "type": "string" }, "device_id": { "description": "ID of the device for which you want to simulate a keypad code entry.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "code" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SIMULATE_KEYPAD_CODE_ENTRY" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate a Keypad Code Entry", "tags": [ "/locks" ], "x-action-attempt-type": "SIMULATE_KEYPAD_CODE_ENTRY", "x-response-key": "action_attempt", "x-title": "Simulate a Keypad Code Entry", "x-mint": { "href": "/api/locks/simulate/keypad_code_entry" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.locks.simulate.keypadCodeEntry({\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n});\n\n/*\n{\n \"action_attempt_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"action_type\": \"SIMULATE_KEYPAD_CODE_ENTRY\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/keypad_code_entry\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->locks->simulate->keypad_code_entry(\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n);\n\n// [\n \"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam locks simulate keypad-code-entry --device_id \"97a7a706-05a9-405c-91e5-b03e5b9c2003\" --code \"1234\"\n\n# {\n# \"action_attempt_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n# \"action_type\": \"SIMULATE_KEYPAD_CODE_ENTRY\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/locks/simulate/manual_lock_via_keypad": { "post": { "description": "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).", "operationId": "locksSimulateManualLockViaKeypadPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to simulate a manual lock action using a keypad.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SIMULATE_MANUAL_LOCK_VIA_KEYPAD" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate a Manual Lock Action Using a Keypad", "tags": [ "/locks" ], "x-action-attempt-type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD", "x-response-key": "action_attempt", "x-title": "Simulate a Manual Lock Action Using a Keypad", "x-mint": { "href": "/api/locks/simulate/manual_lock_via_keypad" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.locks.simulate.manualLockViaKeypad({\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n});\n\n/*\n{\n \"action_attempt_id\": \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n \"action_type\": \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/manual_lock_via_keypad\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n \"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->locks->simulate->manual_lock_via_keypad(\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n);\n\n// [\n \"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n \"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam locks simulate manual-lock-via-keypad --device_id \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\"\n\n# {\n# \"action_attempt_id\": \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n# \"action_type\": \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/locks/unlock_door": { "post": { "description": "Unlocks a [lock](/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](/low-level-apis/smart-locks/lock-and-unlock).", "operationId": "locksUnlockDoorPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the lock that you want to unlock.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "UNLOCK_DOOR" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Unlock a Lock", "tags": [ "/locks" ], "x-action-attempt-type": "UNLOCK_DOOR", "x-response-key": "action_attempt", "x-title": "Unlock a Lock", "x-mint": { "href": "/api/locks/unlock_door" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.locks.unlockDoor({\n device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\",\n});\n\n/*\n{\n \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\": \"UNLOCK_DOOR\",\n \"error\": null,\n \"result\": {\n \"was_confirmed_by_device\": false\n },\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/locks/unlock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->locks->unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\");\n\n// [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam locks unlock-door --device_id \"be047431-bf00-4da6-9fc7-0a7796a9b57f\"\n\n# {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# }" } ] } }, "/noise_sensors/list": { "get": { "description": "Returns a list of all [noise sensors](/capability-guides/noise-sensors).", "operationId": "noiseSensorsListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_ids", "schema": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_type", "schema": { "description": "Device type of the noise sensors that you want to list.", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" } }, { "in": "query", "name": "device_types", "schema": { "description": "Device types of the noise sensors that you want to list.", "items": { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "manufacturer", "schema": { "description": "Manufacturers of the noise sensors that you want to list.", "enum": [ "minut", "noiseaware" ], "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "unstable_location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "noise_sensors": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "noise_sensors", "devices", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/noise_sensors/list", "tags": [ "/noise_sensors" ], "x-fern-sdk-group-name": [ "noise_sensors" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Noise Sensors" }, "post": { "description": "Returns a list of all [noise sensors](/capability-guides/noise-sensors).", "operationId": "noiseSensorsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_ids": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_before": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" }, "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list devices.", "type": "string" }, "device_ids": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_type": { "description": "Device type of the noise sensors that you want to list.", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, "device_types": { "description": "Device types of the noise sensors that you want to list.", "items": { "description": "Device type for noise sensors.\n ", "enum": [ "noiseaware_activity_zone", "minut_sensor" ], "type": "string" }, "type": "array" }, "limit": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" }, "manufacturer": { "description": "Manufacturers of the noise sensors that you want to list.", "enum": [ "minut", "noiseaware" ], "type": "string" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" }, "unstable_location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" } }, "required": [ "devices" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Noise Sensors", "tags": [ "/noise_sensors" ], "x-response-key": "devices", "x-title": "List Noise Sensors", "x-mint": { "href": "/api/noise_sensors/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.list({ limit: 10 });\n\n/*\n[\n {\n \"capabilities_supported\": [\n \"noise_detection\"\n ],\n \"connected_account_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"created_at\": \"2025-05-16T16:54:17.946049Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n \"device_type\": \"minut_sensor\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"Jane's Test Home\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"appearance\": {\n \"name\": \"Living Room\"\n },\n \"battery\": {\n \"level\": 1,\n \"status\": \"full\"\n },\n \"battery_level\": 1,\n \"currently_triggering_noise_threshold_ids\": [],\n \"image_alt_text\": \"Minut Sensor\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n \"manufacturer\": \"minut\",\n \"minut_metadata\": {\n \"device_id\": \"770cd3153deca3dee0fe0614\",\n \"device_location\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"device_name\": \"Living Room\",\n \"home_address\": {\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"notes\": \"string\",\n \"post_code\": \"44210\",\n \"region\": \"San Francisco County\",\n \"street_name1\": \"2258 24th Street\",\n \"street_name2\": \"\"\n },\n \"home_id\": \"2978b6d5dba395ec08300e46\",\n \"home_location\": {\n \"latitude\": 0,\n \"longitude\": 0\n },\n \"home_name\": \"Jane's Test Home\",\n \"latest_sensor_values\": {\n \"accelerometer_z\": {\n \"time\": \"2025-06-16T16:54:17.946049Z\",\n \"value\": -1.00390625\n },\n \"humidity\": {\n \"time\": \"2025-06-16T16:54:17.946049Z\",\n \"value\": 31.110000610351562\n },\n \"pressure\": {\n \"time\": \"2025-06-16T16:54:17.946049Z\",\n \"value\": 101923\n },\n \"sound\": {\n \"time\": \"2025-06-16T16:54:17.946049Z\",\n \"value\": 47.7117919921875\n },\n \"temperature\": {\n \"time\": \"2025-06-16T16:54:17.946049Z\",\n \"value\": 21.270000457763672\n }\n }\n },\n \"model\": {\n \"display_name\": \"Noise Sensor\",\n \"manufacturer_display_name\": \"Minut\"\n },\n \"name\": \"Living Room\",\n \"noise_level_decibels\": 47.7117919921875,\n \"online\": true\n },\n \"warnings\": [],\n \"workspace_id\": \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"capabilities_supported\" => [\"noise_detection\"],\n \"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"created_at\" => \"2025-05-16T16:54:17.946049Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n \"device_type\" => \"minut_sensor\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"Jane's Test Home\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n appearance: {\n name: \"Living Room\",\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n currently_triggering_noise_threshold_ids: [],\n image_alt_text: \"Minut Sensor\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n manufacturer: \"minut\",\n minut_metadata: {\n device_id: \"770cd3153deca3dee0fe0614\",\n device_location: {\n latitude: 0,\n longitude: 0,\n },\n device_name: \"Living Room\",\n home_address: {\n city: \"San Francisco\",\n country: \"US\",\n notes: \"string\",\n post_code: \"44210\",\n region: \"San Francisco County\",\n street_name1: \"2258 24th Street\",\n street_name2: \"\",\n },\n home_id: \"2978b6d5dba395ec08300e46\",\n home_location: {\n latitude: 0,\n longitude: 0,\n },\n home_name: \"Jane's Test Home\",\n latest_sensor_values: {\n accelerometer_z: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: -1.00390625,\n },\n humidity: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 31.110000610351562,\n },\n pressure: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 101_923,\n },\n sound: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 47.7117919921875,\n },\n temperature: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 21.270000457763672,\n },\n },\n },\n model: {\n display_name: \"Noise Sensor\",\n manufacturer_display_name: \"Minut\",\n },\n name: \"Living Room\",\n noise_level_decibels: 47.7117919921875,\n online: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->list(limit: 10);\n\n// [\n [\n \"capabilities_supported\" => [\"noise_detection\"],\n \"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"created_at\" => \"2025-05-16T16:54:17.946049Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n \"device_type\" => \"minut_sensor\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"Jane's Test Home\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"appearance\" => [\"name\" => \"Living Room\"],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"currently_triggering_noise_threshold_ids\" => [],\n \"image_alt_text\" => \"Minut Sensor\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n \"manufacturer\" => \"minut\",\n \"minut_metadata\" => [\n \"device_id\" => \"770cd3153deca3dee0fe0614\",\n \"device_location\" => [\"latitude\" => 0, \"longitude\" => 0],\n \"device_name\" => \"Living Room\",\n \"home_address\" => [\n \"city\" => \"San Francisco\",\n \"country\" => \"US\",\n \"notes\" => \"string\",\n \"post_code\" => \"44210\",\n \"region\" => \"San Francisco County\",\n \"street_name1\" => \"2258 24th Street\",\n \"street_name2\" => \"\",\n ],\n \"home_id\" => \"2978b6d5dba395ec08300e46\",\n \"home_location\" => [\"latitude\" => 0, \"longitude\" => 0],\n \"home_name\" => \"Jane's Test Home\",\n \"latest_sensor_values\" => [\n \"accelerometer_z\" => [\n \"time\" => \"2025-06-16T16:54:17.946049Z\",\n \"value\" => -1.00390625,\n ],\n \"humidity\" => [\n \"time\" => \"2025-06-16T16:54:17.946049Z\",\n \"value\" => 31.110000610351562,\n ],\n \"pressure\" => [\n \"time\" => \"2025-06-16T16:54:17.946049Z\",\n \"value\" => 101923,\n ],\n \"sound\" => [\n \"time\" => \"2025-06-16T16:54:17.946049Z\",\n \"value\" => 47.7117919921875,\n ],\n \"temperature\" => [\n \"time\" => \"2025-06-16T16:54:17.946049Z\",\n \"value\" => 21.270000457763672,\n ],\n ],\n ],\n \"model\" => [\n \"display_name\" => \"Noise Sensor\",\n \"manufacturer_display_name\" => \"Minut\",\n ],\n \"name\" => \"Living Room\",\n \"noise_level_decibels\" => 47.7117919921875,\n \"online\" => true,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors list --limit 10\n\n# [\n# {\n# \"capabilities_supported\": [\n# \"noise_detection\"\n# ],\n# \"connected_account_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n# \"created_at\": \"2025-05-16T16:54:17.946049Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n# \"device_type\": \"minut_sensor\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"Jane's Test Home\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"battery\": {\n# \"level\": 1,\n# \"status\": \"full\"\n# },\n# \"battery_level\": 1,\n# \"currently_triggering_noise_threshold_ids\": [],\n# \"image_alt_text\": \"Minut Sensor\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n# \"manufacturer\": \"minut\",\n# \"minut_metadata\": {\n# \"device_id\": \"770cd3153deca3dee0fe0614\",\n# \"device_location\": {\n# \"latitude\": 0,\n# \"longitude\": 0\n# },\n# \"device_name\": \"Living Room\",\n# \"home_address\": {\n# \"city\": \"San Francisco\",\n# \"country\": \"US\",\n# \"notes\": \"string\",\n# \"post_code\": \"44210\",\n# \"region\": \"San Francisco County\",\n# \"street_name1\": \"2258 24th Street\",\n# \"street_name2\": \"\"\n# },\n# \"home_id\": \"2978b6d5dba395ec08300e46\",\n# \"home_location\": {\n# \"latitude\": 0,\n# \"longitude\": 0\n# },\n# \"home_name\": \"Jane's Test Home\",\n# \"latest_sensor_values\": {\n# \"accelerometer_z\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": -1.00390625\n# },\n# \"humidity\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 31.110000610351562\n# },\n# \"pressure\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 101923\n# },\n# \"sound\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 47.7117919921875\n# },\n# \"temperature\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 21.270000457763672\n# }\n# }\n# },\n# \"model\": {\n# \"display_name\": \"Noise Sensor\",\n# \"manufacturer_display_name\": \"Minut\"\n# },\n# \"name\": \"Living Room\",\n# \"noise_level_decibels\": 47.7117919921875,\n# \"online\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"\n# }\n# ]" } ] } }, "/noise_sensors/noise_thresholds/create": { "post": { "description": "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 default thresholds, but you can use the Seam API to modify them.", "operationId": "noiseSensorsNoiseThresholdsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to create a noise threshold.", "format": "uuid", "type": "string" }, "ends_daily_at": { "description": "Time at which the new noise threshold should become inactive daily.", "type": "string" }, "name": { "description": "Name of the new noise threshold.", "type": "string" }, "noise_threshold_decibels": { "description": "Noise level in decibels for the new noise threshold.", "format": "float", "type": "number" }, "noise_threshold_nrs": { "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](/device-and-system-integration-guides/noiseaware-sensors).", "format": "float", "type": "number" }, "starts_daily_at": { "description": "Time at which the new noise threshold should become active daily.", "type": "string" } }, "required": [ "device_id", "starts_daily_at", "ends_daily_at" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" } }, "required": [ "noise_threshold" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Create a Noise Threshold", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "CREATE_NOISE_THRESHOLD", "x-response-key": "noise_threshold", "x-title": "Create a Noise Threshold", "x-mint": { "href": "/api/noise_sensors/noise_thresholds/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.noiseThresholds.create({\n device_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n name: \"My Noise Sensor\",\n starts_daily_at: \"2025-06-20T18:29:57.000Z\",\n ends_daily_at: \"2025-06-19T12:38:44.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n});\n\n/*\n{\n \"device_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n \"name\": \"My Noise Sensor\",\n \"noise_threshold_decibels\": 50,\n \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\": 40,\n \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->noise_thresholds->create(\n device_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n name: \"My Noise Sensor\",\n starts_daily_at: \"2025-06-20T18:29:57.000Z\",\n ends_daily_at: \"2025-06-19T12:38:44.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n);\n\n// [\n \"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors noise-thresholds create --device_id \"8282891b-c4da-4239-8f01-56089d44b80d\" --name \"My Noise Sensor\" --starts_daily_at \"2025-06-20T18:29:57.000Z\" --ends_daily_at \"2025-06-19T12:38:44.000Z\" --noise_threshold_decibels 50 --noise_threshold_nrs 40\n\n# {\n# \"device_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }" } ] } }, "/noise_sensors/noise_thresholds/delete": { "delete": { "description": "Deletes a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsDeleteDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that contains the noise threshold that you want to delete.", "format": "uuid", "type": "string" }, "noise_threshold_id": { "description": "ID of the noise threshold that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "noise_threshold_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/noise_sensors/noise_thresholds/delete", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "DELETE_NOISE_THRESHOLD", "x-fern-sdk-group-name": [ "noise_sensors", "noise_thresholds" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Noise Threshold" }, "post": { "description": "Deletes a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that contains the noise threshold that you want to delete.", "format": "uuid", "type": "string" }, "noise_threshold_id": { "description": "ID of the noise threshold that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "noise_threshold_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete a Noise Threshold", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "DELETE_NOISE_THRESHOLD", "x-response-key": null, "x-title": "Delete a Noise Threshold", "x-mint": { "href": "/api/noise_sensors/noise_thresholds/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.noiseThresholds.delete({\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->noise_thresholds->delete(\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors noise-thresholds delete --noise_threshold_id \"00fbac13-6602-4079-b4ae-c89d5dcbed35\" --device_id \"736fc5bf-192d-4416-b879-66ff0195f2f7\"\n\n# {}" } ] } }, "/noise_sensors/noise_thresholds/get": { "get": { "description": "Returns a specified [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsGetGet", "parameters": [ { "in": "query", "name": "noise_threshold_id", "required": true, "schema": { "description": "ID of the noise threshold that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" }, "ok": { "type": "boolean" } }, "required": [ "noise_threshold", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/noise_sensors/noise_thresholds/get", "tags": [ "/noise_sensors" ], "x-fern-sdk-group-name": [ "noise_sensors", "noise_thresholds" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "noise_threshold", "x-response-key": "noise_threshold", "x-title": "Get a Noise Threshold" }, "post": { "description": "Returns a specified [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "noise_threshold_id": { "description": "ID of the noise threshold that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "noise_threshold_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noise_threshold": { "$ref": "#/components/schemas/noise_threshold" } }, "required": [ "noise_threshold" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get a Noise Threshold", "tags": [ "/noise_sensors" ], "x-response-key": "noise_threshold", "x-title": "Get a Noise Threshold", "x-mint": { "href": "/api/noise_sensors/noise_thresholds/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.noiseThresholds.get({\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n});\n\n/*\n{\n \"device_id\": \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n \"name\": \"My Noise Sensor\",\n \"noise_threshold_decibels\": 50,\n \"noise_threshold_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"noise_threshold_nrs\": 40,\n \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->noise_thresholds->get(\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n);\n\n// [\n \"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors noise-thresholds get --noise_threshold_id \"8282891b-c4da-4239-8f01-56089d44b80d\"\n\n# {\n# \"device_id\": \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }" } ] } }, "/noise_sensors/noise_thresholds/list": { "get": { "description": "Returns a list of all [noise thresholds](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsListGet", "parameters": [ { "in": "query", "name": "device_id", "required": true, "schema": { "description": "ID of the device for which you want to list noise thresholds.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noise_thresholds": { "items": { "$ref": "#/components/schemas/noise_threshold" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "noise_thresholds", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/noise_sensors/noise_thresholds/list", "tags": [ "/noise_sensors" ], "x-fern-sdk-group-name": [ "noise_sensors", "noise_thresholds" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "noise_thresholds", "x-response-key": "noise_thresholds", "x-title": "List Noise Thresholds" }, "post": { "description": "Returns a list of all [noise thresholds](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to list noise thresholds.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "noise_thresholds": { "items": { "$ref": "#/components/schemas/noise_threshold" }, "type": "array" } }, "required": [ "noise_thresholds" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Noise Thresholds", "tags": [ "/noise_sensors" ], "x-response-key": "noise_thresholds", "x-title": "List Noise Thresholds", "x-mint": { "href": "/api/noise_sensors/noise_thresholds/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.noiseThresholds.list({\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n});\n\n/*\n[\n {\n \"device_id\": \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n \"name\": \"My Noise Sensor\",\n \"noise_threshold_decibels\": 50,\n \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\": 40,\n \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->noise_thresholds->list(\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n);\n\n// [\n [\n \"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors noise-thresholds list --device_id \"a60d1a44-5727-4223-8b58-9c2455eb57fc\"\n\n# [\n# {\n# \"device_id\": \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }\n# ]" } ] } }, "/noise_sensors/noise_thresholds/update": { "patch": { "description": "Updates a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that contains the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "ends_daily_at": { "description": "Time at which the noise threshold should become inactive daily.", "type": "string" }, "name": { "description": "Name of the noise threshold that you want to update.", "type": "string" }, "noise_threshold_decibels": { "description": "Noise level in decibels for the noise threshold.", "format": "float", "type": "number" }, "noise_threshold_id": { "description": "ID of the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "noise_threshold_nrs": { "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](/device-and-system-integration-guides/noiseaware-sensors).", "format": "float", "type": "number" }, "starts_daily_at": { "description": "Time at which the noise threshold should become active daily.", "type": "string" } }, "required": [ "noise_threshold_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/noise_sensors/noise_thresholds/update", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "x-fern-sdk-group-name": [ "noise_sensors", "noise_thresholds" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Noise Threshold" }, "post": { "description": "Updates a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that contains the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "ends_daily_at": { "description": "Time at which the noise threshold should become inactive daily.", "type": "string" }, "name": { "description": "Name of the noise threshold that you want to update.", "type": "string" }, "noise_threshold_decibels": { "description": "Noise level in decibels for the noise threshold.", "format": "float", "type": "number" }, "noise_threshold_id": { "description": "ID of the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "noise_threshold_nrs": { "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](/device-and-system-integration-guides/noiseaware-sensors).", "format": "float", "type": "number" }, "starts_daily_at": { "description": "Time at which the noise threshold should become active daily.", "type": "string" } }, "required": [ "noise_threshold_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Update a Noise Threshold", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "x-response-key": null, "x-title": "Update a Noise Threshold", "x-mint": { "href": "/api/noise_sensors/noise_thresholds/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.noiseThresholds.update({\n noise_threshold_id: \"2cb09850-4962-4dee-a658-d8a79fcb9aff\",\n device_id: \"c3885398-6794-44a0-a7a2-1f39ff454dc3\",\n name: \"My Updated Noise Sensor\",\n starts_daily_at: \"2025-06-18T15:13:17.000Z\",\n ends_daily_at: \"2025-06-17T21:33:58.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->noise_thresholds->update(\n noise_threshold_id: \"2cb09850-4962-4dee-a658-d8a79fcb9aff\",\n device_id: \"c3885398-6794-44a0-a7a2-1f39ff454dc3\",\n name: \"My Updated Noise Sensor\",\n starts_daily_at: \"2025-06-18T15:13:17.000Z\",\n ends_daily_at: \"2025-06-17T21:33:58.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors noise-thresholds update --noise_threshold_id \"2cb09850-4962-4dee-a658-d8a79fcb9aff\" --device_id \"c3885398-6794-44a0-a7a2-1f39ff454dc3\" --name \"My Updated Noise Sensor\" --starts_daily_at \"2025-06-18T15:13:17.000Z\" --ends_daily_at \"2025-06-17T21:33:58.000Z\" --noise_threshold_decibels 50 --noise_threshold_nrs 40\n\n# {}" } ] }, "put": { "description": "Updates a [noise threshold](/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](/capability-guides/noise-sensors).", "operationId": "noiseSensorsNoiseThresholdsUpdatePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device that contains the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "ends_daily_at": { "description": "Time at which the noise threshold should become inactive daily.", "type": "string" }, "name": { "description": "Name of the noise threshold that you want to update.", "type": "string" }, "noise_threshold_decibels": { "description": "Noise level in decibels for the noise threshold.", "format": "float", "type": "number" }, "noise_threshold_id": { "description": "ID of the noise threshold that you want to update.", "format": "uuid", "type": "string" }, "noise_threshold_nrs": { "description": "Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](/device-and-system-integration-guides/noiseaware-sensors).", "format": "float", "type": "number" }, "starts_daily_at": { "description": "Time at which the noise threshold should become active daily.", "type": "string" } }, "required": [ "noise_threshold_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/noise_sensors/noise_thresholds/update", "tags": [ "/noise_sensors" ], "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD", "x-fern-sdk-group-name": [ "noise_sensors", "noise_thresholds" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Noise Threshold" } }, "/noise_sensors/simulate/trigger_noise_threshold": { "post": { "description": "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).", "operationId": "noiseSensorsSimulateTriggerNoiseThresholdPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the device for which you want to simulate the triggering of a noise threshold.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Simulate Triggering a Noise Threshold", "tags": [ "/noise_sensors" ], "x-response-key": null, "x-title": "Simulate Triggering a Noise Threshold", "x-mint": { "href": "/api/noise_sensors/simulate/trigger_noise_threshold" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/simulate/trigger_noise_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->noise_sensors->simulate->trigger_noise_threshold(\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam noise-sensors simulate trigger-noise-threshold --device_id \"c0384c1c-9038-427c-9a72-314d2b168d43\"\n\n# {}" } ] } }, "/phones/deactivate": { "delete": { "description": "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).", "operationId": "phonesDeactivateDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "Device ID of the phone that you want to deactivate.", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/phones/deactivate", "tags": [ "/phones" ], "x-fern-sdk-group-name": [ "phones" ], "x-fern-sdk-method-name": "deactivate", "x-response-key": null, "x-title": "Deactivate a Phone" }, "post": { "description": "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).", "operationId": "phonesDeactivatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "Device ID of the phone that you want to deactivate.", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Deactivate a Phone", "tags": [ "/phones" ], "x-response-key": null, "x-title": "Deactivate a Phone", "x-mint": { "href": "/api/phones/deactivate" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.phones.deactivate({\n device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/phones/deactivate\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\");" }, { "lang": "bash", "label": "Seam CLI", "source": "seam phones deactivate --device_id \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\"\n\n# {}" } ] } }, "/phones/get": { "get": { "description": "Returns a specified [phone](/capability-guides/mobile-access/managing-phones-for-a-user-identity).", "operationId": "phonesGetGet", "parameters": [ { "in": "query", "name": "device_id", "required": true, "schema": { "description": "Device ID of the phone that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "phone": { "$ref": "#/components/schemas/phone" } }, "required": [ "phone", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/phones/get", "tags": [ "/phones" ], "x-fern-sdk-group-name": [ "phones" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "phone", "x-response-key": "phone", "x-title": "Get a Phone" }, "post": { "description": "Returns a specified [phone](/capability-guides/mobile-access/managing-phones-for-a-user-identity).", "operationId": "phonesGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "Device ID of the phone that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "phone": { "$ref": "#/components/schemas/phone" } }, "required": [ "phone" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get a Phone", "tags": [ "/phones" ], "x-response-key": "phone", "x-title": "Get a Phone", "x-mint": { "href": "/api/phones/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.phones.get({ device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\" });\n\n/*\n{\n \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n \"device_type\": \"ios_phone\",\n \"display_name\": \"My Phone\",\n \"errors\": [],\n \"nickname\": \"My Phone\",\n \"properties\": {\n \"assa_abloy_credential_service_metadata\": {\n \"endpoints\": [\n {\n \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\": true\n }\n ],\n \"has_active_endpoint\": true\n }\n },\n \"warnings\": [],\n \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/phones/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->phones->get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\");\n\n// [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => [\n \"assa_abloy_credential_service_metadata\" => [\n \"endpoints\" => [\n [\n \"endpoint_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\" => true,\n ],\n ],\n \"has_active_endpoint\" => true,\n ],\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam phones get --device_id \"2c39adb7-ba99-4b60-927d-9b796952c8e8\"\n\n# {\n# \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n# \"device_type\": \"ios_phone\",\n# \"display_name\": \"My Phone\",\n# \"errors\": [],\n# \"nickname\": \"My Phone\",\n# \"properties\": {\n# \"assa_abloy_credential_service_metadata\": {\n# \"endpoints\": [\n# {\n# \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"is_active\": true\n# }\n# ],\n# \"has_active_endpoint\": true\n# }\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n# }" } ] } }, "/phones/list": { "get": { "description": "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.", "operationId": "phonesListGet", "parameters": [ { "in": "query", "name": "owner_user_identity_id", "schema": { "description": "ID of the user identity that represents the owner by which you want to filter the list of returned phones.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_credential_id", "schema": { "description": "ID of the [credential](/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "phones": { "items": { "$ref": "#/components/schemas/phone" }, "type": "array" } }, "required": [ "phones", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/phones/list", "tags": [ "/phones" ], "x-fern-sdk-group-name": [ "phones" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "phones", "x-response-key": "phones", "x-title": "List Phones" }, "post": { "description": "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.", "operationId": "phonesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_credential_id": { "description": "ID of the [credential](/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.", "format": "uuid", "type": "string" }, "owner_user_identity_id": { "description": "ID of the user identity that represents the owner by which you want to filter the list of returned phones.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "phones": { "items": { "$ref": "#/components/schemas/phone" }, "type": "array" } }, "required": [ "phones" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Phones", "tags": [ "/phones" ], "x-response-key": "phones", "x-title": "List Phones", "x-mint": { "href": "/api/phones/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.phones.list({\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n});\n\n/*\n[\n {\n \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\": \"ios_phone\",\n \"display_name\": \"My Phone\",\n \"errors\": [],\n \"nickname\": \"My Phone\",\n \"properties\": {\n \"assa_abloy_credential_service_metadata\": {\n \"endpoints\": [\n {\n \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\": true\n }\n ],\n \"has_active_endpoint\": true\n }\n },\n \"warnings\": [],\n \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/phones/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->phones->list(\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n);\n\n// [\n [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => [\n \"assa_abloy_credential_service_metadata\" => [\n \"endpoints\" => [\n [\n \"endpoint_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\" => true,\n ],\n ],\n \"has_active_endpoint\" => true,\n ],\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam phones list --owner_user_identity_id \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\"\n\n# [\n# {\n# \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n# \"device_type\": \"ios_phone\",\n# \"display_name\": \"My Phone\",\n# \"errors\": [],\n# \"nickname\": \"My Phone\",\n# \"properties\": {\n# \"assa_abloy_credential_service_metadata\": {\n# \"endpoints\": [\n# {\n# \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"is_active\": true\n# }\n# ],\n# \"has_active_endpoint\": true\n# }\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n# }\n# ]" } ] } }, "/phones/simulate/create_sandbox_phone": { "post": { "description": "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).", "operationId": "phonesSimulateCreateSandboxPhonePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "assa_abloy_metadata": { "default": {}, "description": "ASSA ABLOY metadata that you want to associate with the simulated phone.", "properties": { "application_version": { "default": "1.0.0", "description": "Application version that you want to use for the simulated phone.", "type": "string" }, "ble_capability": { "default": true, "description": "Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.", "type": "boolean" }, "hce_capability": { "default": false, "description": "Indicates whether the simulated phone should have host card emulation (HCE) capability.", "type": "boolean" }, "nfc_capability": { "default": false, "description": "Indicates whether the simulated phone should have near-field communication (NFC) capability.", "type": "boolean" }, "seos_applet_version": { "default": "1.0.0", "description": "SEOS applet version that you want to use for the simulated phone.", "type": "string" }, "seos_tsm_endpoint_id": { "default": 1, "description": "ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.", "format": "float", "type": "number" } }, "type": "object" }, "custom_sdk_installation_id": { "description": "ID of the custom SDK installation that you want to use for the simulated phone.", "type": "string" }, "phone_metadata": { "default": {}, "description": "Metadata that you want to associate with the simulated phone.", "properties": { "device_manufacturer": { "default": "Samsung", "description": "Manufacturer that you want to use for the simulated phone.", "type": "string" }, "device_model": { "default": "Samsung Galaxy S10", "description": "Device model that you want to use for the simulated phone.", "type": "string" }, "operating_system": { "default": "android", "description": "Mobile operating system that you want to use for the simulated phone.", "enum": [ "android", "ios" ], "type": "string" }, "os_version": { "default": "10", "description": "Mobile operating system version that you want to use for the simulated phone.", "type": "string" } }, "type": "object" }, "user_identity_id": { "description": "ID of the user identity that you want to associate with the simulated phone.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "phone": { "$ref": "#/components/schemas/phone" } }, "required": [ "phone" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Create a Sandbox Phone", "tags": [ "/phones" ], "x-response-key": "phone", "x-title": "Create a Sandbox Phone", "x-mint": { "href": "/api/phones/simulate/create_sandbox_phone" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.phones.simulate.createSandboxPhone({\n custom_sdk_installation_id: \"visionline_sdk\",\n user_identity_id: \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\",\n phone_metadata: {\n operating_system: \"android\",\n os_version: 10,\n device_manufacturer: \"Samsung\",\n device_model: \"Samsung Galaxy S10\",\n },\n assa_abloy_metadata: {\n ble_capability: \"true,\",\n hce_capability: \"false,\",\n nfc_capability: \"false,\",\n application_version: \"1.0.0\",\n seos_applet_version: \"1.0.0\",\n seos_tsm_endpoint_id: 1,\n },\n});\n\n/*\n{\n \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\": \"android_phone\",\n \"display_name\": \"My Phone\",\n \"errors\": [],\n \"nickname\": \"My Phone\",\n \"properties\": {\n \"assa_abloy_credential_service_metadata\": {\n \"endpoints\": [\n {\n \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\": true\n }\n ],\n \"has_active_endpoint\": true\n }\n },\n \"warnings\": [],\n \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/phones/simulate/create_sandbox_phone\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"android_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->phones->simulate->create_sandbox_phone(\n custom_sdk_installation_id: \"visionline_sdk\",\n user_identity_id: \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\",\n phone_metadata: [\n \"operating_system\" => \"android\",\n \"os_version\" => 10,\n \"device_manufacturer\" => \"Samsung\",\n \"device_model\" => \"Samsung Galaxy S10\",\n ],\n assa_abloy_metadata: [\n \"ble_capability\" => \"true,\",\n \"hce_capability\" => \"false,\",\n \"nfc_capability\" => \"false,\",\n \"application_version\" => \"1.0.0\",\n \"seos_applet_version\" => \"1.0.0\",\n \"seos_tsm_endpoint_id\" => 1,\n ],\n);\n\n// [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"android_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => [\n \"assa_abloy_credential_service_metadata\" => [\n \"endpoints\" => [\n [\n \"endpoint_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"is_active\" => true,\n ],\n ],\n \"has_active_endpoint\" => true,\n ],\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam phones simulate create-sandbox-phone --custom_sdk_installation_id \"visionline_sdk\" --user_identity_id \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\" --phone_metadata {\"operating_system\":\"android\",\"os_version\":10,\"device_manufacturer\":\"Samsung\",\"device_model\":\"Samsung Galaxy S10\"} --assa_abloy_metadata {\"ble_capability\":\"true,\",\"hce_capability\":\"false,\",\"nfc_capability\":\"false,\",\"application_version\":\"1.0.0\",\"seos_applet_version\":\"1.0.0\",\"seos_tsm_endpoint_id\":1}\n\n# {\n# \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n# \"device_type\": \"android_phone\",\n# \"display_name\": \"My Phone\",\n# \"errors\": [],\n# \"nickname\": \"My Phone\",\n# \"properties\": {\n# \"assa_abloy_credential_service_metadata\": {\n# \"endpoints\": [\n# {\n# \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"is_active\": true\n# }\n# ],\n# \"has_active_endpoint\": true\n# }\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n# }" } ] } }, "/spaces/add_acs_entrances": { "post": { "description": "Adds [entrances](/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.", "operationId": "spacesAddAcsEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to add to the space.", "items": { "format": "uuid", "type": "string" }, "minItems": 1, "type": "array" }, "space_id": { "description": "ID of the space to which you want to add entrances.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "acs_entrance_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Add Entrances to a Space", "tags": [], "x-response-key": null, "x-title": "Add Entrances to a Space", "x-mint": { "href": "/api/spaces/add_acs_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.addAcsEntrances({\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->add_acs_entrances(\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces add-acs-entrances --space_id \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\" --acs_entrance_ids [\"b127a710-db3e-402c-afdf-5474769b1d83\"]\n\n# {}" } ] }, "put": { "description": "Adds [entrances](/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.", "operationId": "spacesAddAcsEntrancesPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to add to the space.", "items": { "format": "uuid", "type": "string" }, "minItems": 1, "type": "array" }, "space_id": { "description": "ID of the space to which you want to add entrances.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "acs_entrance_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/add_acs_entrances", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "add_acs_entrances", "x-response-key": null, "x-title": "Add Entrances to a Space" } }, "/spaces/add_connected_account": { "post": { "description": "Adds a [connected account](/core-concepts/connected-accounts) to a specific space.", "operationId": "spacesAddConnectedAccountPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to add to the space.", "format": "uuid", "type": "string" }, "space_id": { "description": "ID of the space to which you want to add the connected account.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Add a Connected Account to a Space", "tags": [], "x-response-key": null, "x-title": "Add a Connected Account to a Space", "x-mint": { "href": "/api/spaces/add_connected_account" } }, "put": { "description": "Adds a [connected account](/core-concepts/connected-accounts) to a specific space.", "operationId": "spacesAddConnectedAccountPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to add to the space.", "format": "uuid", "type": "string" }, "space_id": { "description": "ID of the space to which you want to add the connected account.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/add_connected_account", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "add_connected_account", "x-response-key": null, "x-title": "Add a Connected Account to a Space" } }, "/spaces/add_devices": { "post": { "description": "Adds devices to a specific space.", "operationId": "spacesAddDevicesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_ids": { "description": "IDs of the devices that you want to add to the space.", "items": { "format": "uuid", "type": "string" }, "minItems": 1, "type": "array" }, "space_id": { "description": "ID of the space to which you want to add devices.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "device_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Add Devices to a Space", "tags": [], "x-response-key": null, "x-title": "Add Devices to a Space", "x-mint": { "href": "/api/spaces/add_devices" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.addDevices({\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->add_devices(\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces add-devices --space_id \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\" --device_ids [\"22fb4992-463c-4ccd-b568-50fcea243665\"]\n\n# {}" } ] }, "put": { "description": "Adds devices to a specific space.", "operationId": "spacesAddDevicesPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_ids": { "description": "IDs of the devices that you want to add to the space.", "items": { "format": "uuid", "type": "string" }, "minItems": 1, "type": "array" }, "space_id": { "description": "ID of the space to which you want to add devices.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "device_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/add_devices", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "add_devices", "x-response-key": null, "x-title": "Add Devices to a Space" } }, "/spaces/create": { "post": { "description": "Creates a new space.", "operationId": "spacesCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to add to the new space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "connected_account_ids": { "description": "IDs of connected accounts to associate with the new space. Persisted on seam.location_third_party_account so the UI can show which provider account(s) a space came from.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "customer_data": { "description": "Reservation/stay-related defaults for the space.", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "customer_key": { "description": "Customer key for which you want to create the space.", "minLength": 1, "type": "string" }, "device_ids": { "description": "IDs of the devices that you want to add to the new space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "name": { "description": "Name of the space that you want to create.", "type": "string" }, "space_key": { "description": "Unique key for the space within the workspace.", "type": "string" } }, "required": [ "name" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "space": { "$ref": "#/components/schemas/space" } }, "required": [ "space" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Create a Space", "tags": [], "x-response-key": "space", "x-title": "Create a Space", "x-mint": { "href": "/api/spaces/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.create({\n name: \"My Space\",\n device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\n acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"],\n});\n\n/*\n{\n \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n \"display_name\": \"My Space\",\n \"name\": \"My Space\",\n \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->create(\n name: \"My Space\",\n device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\n acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"],\n);\n\n// [\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces create --name \"My Space\" --device_ids [\"b7254403-db91-4e10-bb7b-31d0615d2963\"] --acs_entrance_ids [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"]\n\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Space\",\n# \"name\": \"My Space\",\n# \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }" } ] } }, "/spaces/delete": { "delete": { "description": "Deletes a space.", "operationId": "spacesDeleteDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "space_id": { "description": "ID of the space that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "space_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/delete", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Space" }, "post": { "description": "Deletes a space.", "operationId": "spacesDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "space_id": { "description": "ID of the space that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "space_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Delete a Space", "tags": [], "x-response-key": null, "x-title": "Delete a Space", "x-mint": { "href": "/api/spaces/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.delete({ space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\" });\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\");" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces delete --space_id \"a7cd0163-4e94-41ae-b5b7-da6040a65509\"\n\n# {}" } ] } }, "/spaces/get": { "get": { "description": "Gets a space.", "operationId": "spacesGetGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "space": { "$ref": "#/components/schemas/space" } }, "required": [ "space", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/get", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "space", "x-response-key": "space", "x-title": "Get a Space" }, "post": { "description": "Gets a space.", "operationId": "spacesGetPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "space_id": { "description": "ID of the space that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "space_id" ], "type": "object" }, { "properties": { "space_key": { "description": "Unique key of the space that you want to get.", "type": "string" } }, "required": [ "space_key" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "space": { "$ref": "#/components/schemas/space" } }, "required": [ "space" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get a Space", "tags": [], "x-response-key": "space", "x-title": "Get a Space", "x-mint": { "href": "/api/spaces/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.get({ space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\" });\n\n/*\n{\n \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n \"display_name\": \"My Space\",\n \"name\": \"My Space\",\n \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\");\n\n// [\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces get --space_id \"5f30970d-6ef5-4618-9e91-e701fbca6b63\"\n\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Space\",\n# \"name\": \"My Space\",\n# \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }" } ] } }, "/spaces/get_related": { "get": { "description": "Gets all related resources for one or more Spaces.", "operationId": "spacesGetRelatedGet", "parameters": [ { "in": "query", "name": "space_ids", "schema": { "description": "IDs of the spaces that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "space_keys", "schema": { "description": "Keys of the spaces that you want to get along with their related resources.", "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "include", "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "exclude", "schema": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" }, "ok": { "type": "boolean" } }, "required": [ "batch", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/get_related", "tags": [], "x-batch-keys": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "get_related", "x-fern-sdk-return-value": "batch", "x-response-key": "batch", "x-title": "Get related Space resources" }, "post": { "description": "Gets all related resources for one or more Spaces.", "operationId": "spacesGetRelatedPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "exclude": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "type": "string" }, "type": "array" }, "include": { "items": { "enum": [ "spaces", "devices", "acs_entrances", "connected_accounts", "acs_systems", "access_methods" ], "type": "string" }, "type": "array" }, "space_ids": { "description": "IDs of the spaces that you want to get along with their related resources.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "space_keys": { "description": "Keys of the spaces that you want to get along with their related resources.", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "batch": { "description": "A batch of workspace resources.", "properties": { "access_methods": { "items": { "$ref": "#/components/schemas/access_method" }, "type": "array" }, "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "connected_accounts": { "items": { "$ref": "#/components/schemas/connected_account" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "type": "object", "x-route-path": "/workspaces" } }, "required": [ "batch" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Get related Space resources", "tags": [], "x-response-key": "batch", "x-title": "Get related Space resources", "x-mint": { "href": "/api/spaces/get_related" } } }, "/spaces/list": { "get": { "description": "Returns a list of all spaces.", "operationId": "spacesListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list spaces.", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.", "minLength": 1, "type": "string" } }, { "in": "query", "name": "space_key", "schema": { "description": "Filter spaces by space_key.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "format": "float", "type": "number" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "required": [ "spaces", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/list", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "spaces", "x-response-key": "spaces", "x-title": "List Spaces" }, "post": { "description": "Returns a list of all spaces.", "operationId": "spacesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "customer_key": { "description": "Customer key for which you want to list spaces.", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "format": "float", "type": "number" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.", "minLength": 1, "type": "string" }, "space_key": { "description": "Filter spaces by space_key.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pagination": { "$ref": "#/components/schemas/pagination" }, "spaces": { "items": { "$ref": "#/components/schemas/space" }, "type": "array" } }, "required": [ "spaces", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "List Spaces", "tags": [], "x-response-key": "spaces", "x-title": "List Spaces", "x-mint": { "href": "/api/spaces/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.list();\n\n/*\n[\n {\n \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n \"display_name\": \"My Space\",\n \"name\": \"My Space\",\n \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"spaces\": [\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Space\",\n# \"name\": \"My Space\",\n# \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.spaces.list()\n\n# [\n Space(\n created_at=\"2025-06-16T16:54:17.946600Z\",\n display_name=\"My Space\",\n name=\"My Space\",\n space_id=\"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n workspace_id=\"96bd12f9-6def-4bf4-b517-760417451ae9\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.spaces.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->list();\n\n// [\n [\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces list\n\n# [\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Space\",\n# \"name\": \"My Space\",\n# \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }\n# ]" } ] } }, "/spaces/remove_acs_entrances": { "delete": { "description": "Removes [entrances](/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.", "operationId": "spacesRemoveAcsEntrancesDelete", "parameters": [ { "in": "query", "name": "space_id", "required": true, "schema": { "description": "ID of the space from which you want to remove entrances.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_entrance_ids", "required": true, "schema": { "description": "IDs of the entrances that you want to remove from the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/remove_acs_entrances", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "remove_acs_entrances", "x-response-key": null, "x-title": "Remove Entrances from a Space" }, "post": { "description": "Removes [entrances](/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.", "operationId": "spacesRemoveAcsEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to remove from the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "space_id": { "description": "ID of the space from which you want to remove entrances.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "acs_entrance_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Remove Entrances from a Space", "tags": [], "x-response-key": null, "x-title": "Remove Entrances from a Space", "x-mint": { "href": "/api/spaces/remove_acs_entrances" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.removeAcsEntrances({\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->remove_acs_entrances(\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces remove-acs-entrances --space_id \"674e511a-06c6-4734-b4ce-af467496d5fe\" --acs_entrance_ids [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"]\n\n# {}" } ] } }, "/spaces/remove_connected_account": { "delete": { "description": "Removes a [connected account](/core-concepts/connected-accounts) from a specific space.", "operationId": "spacesRemoveConnectedAccountDelete", "parameters": [ { "in": "query", "name": "space_id", "required": true, "schema": { "description": "ID of the space from which you want to remove the connected account.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_id", "required": true, "schema": { "description": "ID of the connected account that you want to remove from the space.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/remove_connected_account", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "remove_connected_account", "x-response-key": null, "x-title": "Remove a Connected Account from a Space" }, "post": { "description": "Removes a [connected account](/core-concepts/connected-accounts) from a specific space.", "operationId": "spacesRemoveConnectedAccountPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connected_account_id": { "description": "ID of the connected account that you want to remove from the space.", "format": "uuid", "type": "string" }, "space_id": { "description": "ID of the space from which you want to remove the connected account.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "connected_account_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Remove a Connected Account from a Space", "tags": [], "x-response-key": null, "x-title": "Remove a Connected Account from a Space", "x-mint": { "href": "/api/spaces/remove_connected_account" } } }, "/spaces/remove_devices": { "delete": { "description": "Removes devices from a specific space.", "operationId": "spacesRemoveDevicesDelete", "parameters": [ { "in": "query", "name": "space_id", "required": true, "schema": { "description": "ID of the space from which you want to remove devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_ids", "required": true, "schema": { "description": "IDs of the devices that you want to remove from the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/remove_devices", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "remove_devices", "x-response-key": null, "x-title": "Remove Devices from a Space" }, "post": { "description": "Removes devices from a specific space.", "operationId": "spacesRemoveDevicesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_ids": { "description": "IDs of the devices that you want to remove from the space.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "space_id": { "description": "ID of the space from which you want to remove devices.", "format": "uuid", "type": "string" } }, "required": [ "space_id", "device_ids" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Remove Devices from a Space", "tags": [], "x-response-key": null, "x-title": "Remove Devices from a Space", "x-mint": { "href": "/api/spaces/remove_devices" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.removeDevices({\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->remove_devices(\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces remove-devices --space_id \"6df14344-4114-4d74-9ef4-2e1208378cda\" --device_ids [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"]\n\n# {}" } ] } }, "/spaces/update": { "patch": { "description": "Updates an existing space.", "operationId": "spacesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "customer_data": { "description": "Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "device_ids": { "description": "IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "name": { "description": "Name of the space.", "type": "string" }, "space_id": { "description": "ID of the space that you want to update.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key of the space that you want to update.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "space": { "$ref": "#/components/schemas/space" } }, "required": [ "space", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "/spaces/update", "tags": [], "x-fern-sdk-group-name": [ "spaces" ], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "space", "x-response-key": "space", "x-title": "Update a Space" }, "post": { "description": "Updates an existing space.", "operationId": "spacesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_entrance_ids": { "description": "IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "customer_data": { "description": "Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.", "properties": { "address": { "description": "Postal address for the space.", "nullable": true, "type": "string" }, "default_checkin_time": { "description": "Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "default_checkout_time": { "description": "Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.", "nullable": true, "pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$", "type": "string" }, "time_zone": { "description": "IANA time zone for the space, e.g. America/Los_Angeles.", "nullable": true, "type": "string" } }, "type": "object" }, "device_ids": { "description": "IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "name": { "description": "Name of the space.", "type": "string" }, "space_id": { "description": "ID of the space that you want to update.", "format": "uuid", "type": "string" }, "space_key": { "description": "Unique key of the space that you want to update.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "space": { "$ref": "#/components/schemas/space" } }, "required": [ "space" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session_with_customer": [] } ], "summary": "Update a Space", "tags": [], "x-response-key": "space", "x-title": "Update a Space", "x-mint": { "href": "/api/spaces/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.spaces.update({\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n});\n\n/*\n{\n \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n \"display_name\": \"My Updated Space\",\n \"name\": \"My Updated Space\",\n \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/spaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Updated Space\",\n \"name\" => \"My Updated Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->spaces->update(\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n);\n\n// [\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Updated Space\",\n \"name\" => \"My Updated Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam spaces update --space_id \"d3513c20-dc89-4e19-8713-1c3ab01aec81\" --name \"My Updated Space\"\n\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Updated Space\",\n# \"name\": \"My Updated Space\",\n# \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }" } ] } }, "/thermostats/activate_climate_preset": { "post": { "description": "Activates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsActivateClimatePresetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Climate preset key of the climate preset that you want to activate.", "type": "string" }, "device_id": { "description": "ID of the thermostat device for which you want to activate a climate preset.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "ACTIVATE_CLIMATE_PRESET" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Activate a Climate Preset", "tags": [ "/thermostats" ], "x-action-attempt-type": "ACTIVATE_CLIMATE_PRESET", "x-response-key": "action_attempt", "x-title": "Activate a Climate Preset", "x-mint": { "href": "/api/thermostats/activate_climate_preset" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.activateClimatePreset({\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n{\n \"action_attempt_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"action_type\": \"ACTIVATE_CLIMATE_PRESET\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/activate_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->activate_climate_preset(\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n);\n\n// [\n \"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats activate-climate-preset --device_id \"52b88155-5b81-47d2-b04d-28a802bd7395\" --climate_preset_key \"Eco\"\n\n# {\n# \"action_attempt_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n# \"action_type\": \"ACTIVATE_CLIMATE_PRESET\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/cool": { "post": { "description": "Sets a specified [thermostat](/capability-guides/thermostats) to [cool mode](/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsCoolPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "cooling_set_point_celsius": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device that you want to set to cool mode.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_HVAC_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set to Cool Mode", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_HVAC_MODE", "x-response-key": "action_attempt", "x-title": "Set to Cool Mode", "x-mint": { "href": "/api/thermostats/cool" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.cool({\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n});\n\n/*\n{\n \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\": \"SET_HVAC_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->cool(\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n);\n\n// [\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats cool --device_id \"408641ab-d0f5-475c-b8a5-9b9096405f9a\" --cooling_set_point_fahrenheit 75\n\n# {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/create_climate_preset": { "post": { "description": "Creates a [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsCreateClimatePresetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want create a climate preset.", "format": "uuid", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "default": true, "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat or using the API can change the thermostat's settings.", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "summary": "Create a Climate Preset", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Create a Climate Preset", "x-mint": { "href": "/api/thermostats/create_climate_preset" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.createClimatePreset({\n device_id: \"ba9b816d-c255-46b9-a16d-971e6f535dd3\",\n manual_override_allowed: true,\n climate_preset_key: \"Occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/create_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->create_climate_preset(\n device_id: \"ba9b816d-c255-46b9-a16d-971e6f535dd3\",\n manual_override_allowed: true,\n climate_preset_key: \"Occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats create-climate-preset --device_id \"ba9b816d-c255-46b9-a16d-971e6f535dd3\" --manual_override_allowed true --climate_preset_key \"Occupied\" --name \"Occupied\" --fan_mode_setting \"auto\" --hvac_mode_setting \"heat_cool\" --cooling_set_point_celsius 25 --heating_set_point_celsius 20\n\n# {}" } ] } }, "/thermostats/daily_programs/create": { "post": { "description": "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.", "operationId": "thermostatsDailyProgramsCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to create a daily program.", "format": "uuid", "type": "string" }, "name": { "description": "Name of the thermostat daily program.", "type": "string" }, "periods": { "description": "Array of thermostat daily program periods.", "items": { "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.", "type": "string" }, "starts_at_time": { "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "type": "string" } }, "required": [ "starts_at_time", "climate_preset_key" ], "type": "object" }, "type": "array" } }, "required": [ "device_id", "name", "periods" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thermostat_daily_program": { "$ref": "#/components/schemas/thermostat_daily_program" } }, "required": [ "thermostat_daily_program" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Create a Thermostat Daily Program", "tags": [ "/thermostats" ], "x-response-key": "thermostat_daily_program", "x-title": "Create a Thermostat Daily Program", "x-mint": { "href": "/api/thermostats/daily_programs/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.dailyPrograms.create({\n device_id: \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"16:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n});\n\n/*\n{\n \"created_at\": \"2025-06-14T16:54:17.946642Z\",\n \"device_id\": \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"Away\"\n },\n {\n \"starts_at_time\": \"16:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"22:30:00\",\n \"climate_preset_key\": \"Sleep\"\n }\n ],\n \"thermostat_daily_program_id\": \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n \"workspace_id\": \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946642Z\",\n \"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"16:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n \"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n \"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->daily_programs->create(\n device_id: \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n name: \"Weekday Program\",\n periods: [\n [\"starts_at_time\" => \"07:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"09:00:00\", \"climate_preset_key\" => \"Away\"],\n [\"starts_at_time\" => \"16:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"22:30:00\", \"climate_preset_key\" => \"Sleep\"],\n ],\n);\n\n// [\n \"created_at\" => \"2025-06-14T16:54:17.946642Z\",\n \"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\"starts_at_time\" => \"07:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"09:00:00\", \"climate_preset_key\" => \"Away\"],\n [\"starts_at_time\" => \"16:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"22:30:00\", \"climate_preset_key\" => \"Sleep\"],\n ],\n \"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n \"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats daily-programs create --device_id \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\" --name \"Weekday Program\" --periods [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"16:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}]\n\n# {\n# \"created_at\": \"2025-06-14T16:54:17.946642Z\",\n# \"device_id\": \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"Home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"Away\"\n# },\n# {\n# \"starts_at_time\": \"16:00:00\",\n# \"climate_preset_key\": \"Home\"\n# },\n# {\n# \"starts_at_time\": \"22:30:00\",\n# \"climate_preset_key\": \"Sleep\"\n# }\n# ],\n# \"thermostat_daily_program_id\": \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n# \"workspace_id\": \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\"\n# }" } ] } }, "/thermostats/daily_programs/delete": { "delete": { "description": "Deletes a thermostat daily program.", "operationId": "thermostatsDailyProgramsDeleteDelete", "parameters": [ { "in": "query", "name": "thermostat_daily_program_id", "required": true, "schema": { "description": "ID of the thermostat daily program that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/daily_programs/delete", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats", "daily_programs" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Thermostat Daily Program" }, "post": { "description": "Deletes a thermostat daily program.", "operationId": "thermostatsDailyProgramsDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "thermostat_daily_program_id": { "description": "ID of the thermostat daily program that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_daily_program_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete a Thermostat Daily Program", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Delete a Thermostat Daily Program", "x-mint": { "href": "/api/thermostats/daily_programs/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.dailyPrograms.delete({\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->daily_programs->delete(\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats daily-programs delete --thermostat_daily_program_id \"a8665859-629e-4696-88b1-1eda1976250a\"\n\n# {}" } ] } }, "/thermostats/daily_programs/update": { "patch": { "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "operationId": "thermostatsDailyProgramsUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name of the thermostat daily program that you want to update.", "type": "string" }, "periods": { "description": "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.", "items": { "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.", "type": "string" }, "starts_at_time": { "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "type": "string" } }, "required": [ "starts_at_time", "climate_preset_key" ], "type": "object" }, "type": "array" }, "thermostat_daily_program_id": { "description": "ID of the thermostat daily program that you want to update.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_daily_program_id", "name", "periods" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "$ref": "#/components/schemas/action_attempt" }, "ok": { "type": "boolean" } }, "required": [ "action_attempt", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/daily_programs/update", "tags": [ "/thermostats" ], "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "x-fern-sdk-group-name": [ "thermostats", "daily_programs" ], "x-fern-sdk-method-name": "update", "x-fern-sdk-return-value": "action_attempt", "x-response-key": "action_attempt", "x-title": "Update a Thermostat Daily Program" }, "post": { "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "operationId": "thermostatsDailyProgramsUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Name of the thermostat daily program that you want to update.", "type": "string" }, "periods": { "description": "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.", "items": { "description": "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.", "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.", "type": "string" }, "starts_at_time": { "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "pattern": "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$", "type": "string" } }, "required": [ "starts_at_time", "climate_preset_key" ], "type": "object" }, "type": "array" }, "thermostat_daily_program_id": { "description": "ID of the thermostat daily program that you want to update.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_daily_program_id", "name", "periods" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "PUSH_THERMOSTAT_PROGRAMS" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update a Thermostat Daily Program", "tags": [ "/thermostats" ], "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "x-response-key": "action_attempt", "x-title": "Update a Thermostat Daily Program", "x-mint": { "href": "/api/thermostats/daily_programs/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.dailyPrograms.update({\n thermostat_daily_program_id: \"6baf3a53-ba83-4052-8ea5-143584e18f03\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"17:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n});\n\n/*\n{\n \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->daily_programs->update(\n thermostat_daily_program_id: \"6baf3a53-ba83-4052-8ea5-143584e18f03\",\n name: \"Weekday Program\",\n periods: [\n [\"starts_at_time\" => \"07:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"09:00:00\", \"climate_preset_key\" => \"Away\"],\n [\"starts_at_time\" => \"17:00:00\", \"climate_preset_key\" => \"Home\"],\n [\"starts_at_time\" => \"22:30:00\", \"climate_preset_key\" => \"Sleep\"],\n ],\n);\n\n// [\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats daily-programs update --thermostat_daily_program_id \"6baf3a53-ba83-4052-8ea5-143584e18f03\" --name \"Weekday Program\" --periods [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"17:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}]\n\n# {\n# \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/delete_climate_preset": { "delete": { "description": "Deletes a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsDeleteClimatePresetDelete", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Climate preset key of the climate preset that you want to delete.", "type": "string" }, "device_id": { "description": "ID of the thermostat device for which you want to delete a climate preset.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/delete_climate_preset", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats" ], "x-fern-sdk-method-name": "delete_climate_preset", "x-response-key": null, "x-title": "Delete a Climate Preset" }, "post": { "description": "Deletes a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsDeleteClimatePresetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Climate preset key of the climate preset that you want to delete.", "type": "string" }, "device_id": { "description": "ID of the thermostat device for which you want to delete a climate preset.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete a Climate Preset", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Delete a Climate Preset", "x-mint": { "href": "/api/thermostats/delete_climate_preset" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.deleteClimatePreset({\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/delete_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->delete_climate_preset(\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats delete-climate-preset --device_id \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\" --climate_preset_key \"Eco\"\n\n# {}" } ] } }, "/thermostats/heat": { "post": { "description": "Sets a specified [thermostat](/capability-guides/thermostats) to [heat mode](/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsHeatPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device that you want to set to heat mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_HVAC_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set to Heat Mode", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_HVAC_MODE", "x-response-key": "action_attempt", "x-title": "Set to Heat Mode", "x-mint": { "href": "/api/thermostats/heat" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.heat({\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n});\n\n/*\n{\n \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\": \"SET_HVAC_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->heat(\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n);\n\n// [\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats heat --device_id \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\" --heating_set_point_fahrenheit 65\n\n# {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/heat_cool": { "post": { "description": "Sets a specified [thermostat](/capability-guides/thermostats) to [heat-cool (\"auto\") mode](/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsHeatCoolPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "cooling_set_point_celsius": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device that you want to set to heat-cool mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_HVAC_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set to Heat-Cool (Auto) Mode", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_HVAC_MODE", "x-response-key": "action_attempt", "x-title": "Set to Heat-Cool (Auto) Mode", "x-mint": { "href": "/api/thermostats/heat_cool" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.heatCool({\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});\n\n/*\n{\n \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\": \"SET_HVAC_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat_cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->heat_cool(\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n);\n\n// [\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats heat-cool --device_id \"32f974cc-e817-4bd7-b7f1-be92c80884a1\" --heating_set_point_celsius 20 --cooling_set_point_celsius 25\n\n# {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/list": { "get": { "description": "Returns a list of all [thermostats](/capability-guides/thermostats).", "operationId": "thermostatsListGet", "parameters": [ { "in": "query", "name": "customer_key", "schema": { "description": "Customer key for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "connected_account_id", "schema": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "connected_account_ids", "schema": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "connect_webview_id", "schema": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_type", "schema": { "description": "Device type by which you want to filter thermostat devices.", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" } }, { "in": "query", "name": "device_types", "schema": { "description": "Array of device types by which you want to filter thermostat devices.", "items": { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, "type": "array" } }, { "in": "query", "name": "manufacturer", "schema": { "description": "Manufacturer by which you want to filter thermostat devices.", "enum": [ "ecobee", "honeywell_resideo", "nest", "sensi", "smartthings", "tado" ], "type": "string" } }, { "in": "query", "name": "device_ids", "schema": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "schema": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, { "in": "query", "name": "custom_metadata_has", "schema": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } }, { "in": "query", "name": "unstable_location_id", "schema": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." } }, { "in": "query", "name": "space_id", "schema": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "ok": { "type": "boolean" }, "thermostats": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" } }, "required": [ "thermostats", "devices", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] } ], "summary": "/thermostats/list", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Thermostats" }, "post": { "description": "Returns a list of all [thermostats](/capability-guides/thermostats).", "operationId": "thermostatsListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_webview_id": { "description": "ID of the Connect Webview for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_id": { "description": "ID of the connected account for which you want to list devices.", "format": "uuid", "type": "string" }, "connected_account_ids": { "description": "Array of IDs of the connected accounts for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_before": { "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "format": "date-time", "type": "string" }, "custom_metadata_has": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "description": "Set of key:value [custom metadata](/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.", "type": "object" }, "customer_key": { "description": "Customer key for which you want to list devices.", "type": "string" }, "device_ids": { "description": "Array of device IDs for which you want to list devices.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "device_type": { "description": "Device type by which you want to filter thermostat devices.", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, "device_types": { "description": "Array of device types by which you want to filter thermostat devices.", "items": { "description": "Device type for thermostats.\n ", "enum": [ "ecobee_thermostat", "nest_thermostat", "honeywell_resideo_thermostat", "tado_thermostat", "sensi_thermostat", "smartthings_thermostat" ], "type": "string" }, "type": "array" }, "limit": { "default": 500, "description": "Numerical limit on the number of devices to return.", "format": "float", "type": "number" }, "manufacturer": { "description": "Manufacturer by which you want to filter thermostat devices.", "enum": [ "ecobee", "honeywell_resideo", "nest", "sensi", "smartthings", "tado" ], "type": "string" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.", "minLength": 1, "type": "string" }, "space_id": { "description": "ID of the space for which you want to list devices.", "format": "uuid", "type": "string" }, "unstable_location_id": { "deprecated": true, "format": "uuid", "nullable": true, "type": "string", "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" } }, "required": [ "devices" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session": [] } ], "summary": "List Thermostats", "tags": [ "/thermostats" ], "x-response-key": "devices", "x-title": "List Thermostats", "x-mint": { "href": "/api/thermostats/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.list({ limit: 10 });\n\n/*\n[\n {\n \"can_hvac_cool\": true,\n \"can_hvac_heat\": true,\n \"can_hvac_heat_cool\": true,\n \"can_turn_off_hvac\": true,\n \"capabilities_supported\": [\n \"thermostat\"\n ],\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\": \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\": \"ecobee_thermostat\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"active_climate_preset\": {\n \"can_delete\": true,\n \"can_edit\": true,\n \"climate_preset_key\": \"sleep\",\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 17.77777777777778,\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true\n },\n \"appearance\": {\n \"name\": \"Living Room\"\n },\n \"available_climate_presets\": [\n {\n \"climate_preset_key\": \"sleep\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Sleep\",\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"home\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Home\",\n \"display_name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"work\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Work\",\n \"display_name\": \"Work\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n }\n ],\n \"available_fan_mode_settings\": [\n \"auto\",\n \"on\"\n ],\n \"available_hvac_mode_settings\": [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\"\n ],\n \"current_climate_setting\": {\n \"display_name\": \"Manual Setting\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 25,\n \"heating_set_point_fahrenheit\": 77,\n \"hvac_mode_setting\": \"heat\",\n \"manual_override_allowed\": true\n },\n \"ecobee_metadata\": {\n \"device_name\": \"Living Room\",\n \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n },\n \"fallback_climate_preset_key\": \"eco\",\n \"fan_mode_setting\": \"auto\",\n \"has_direct_power\": true,\n \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\": false,\n \"is_fan_running\": false,\n \"is_heating\": false,\n \"is_temporary_manual_override_active\": false,\n \"manufacturer\": \"ecobee\",\n \"max_cooling_set_point_celsius\": 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\": 92,\n \"max_heating_set_point_celsius\": 26.11111111111111,\n \"max_heating_set_point_fahrenheit\": 79,\n \"min_cooling_set_point_celsius\": 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\": 65,\n \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\": 5,\n \"min_heating_set_point_celsius\": 7.222222222222222,\n \"min_heating_set_point_fahrenheit\": 45,\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Ecobee\"\n },\n \"name\": \"Living Room\",\n \"online\": true,\n \"relative_humidity\": 0.36,\n \"temperature_celsius\": 21.11111111111111,\n \"temperature_fahrenheit\": 70,\n \"temperature_threshold\": {\n \"lower_limit_celsius\": 16.66666666666667,\n \"lower_limit_fahrenheit\": 62,\n \"upper_limit_celsius\": 26.66666666666667,\n \"upper_limit_fahrenheit\": 80\n },\n \"thermostat_daily_programs\": [\n {\n \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"work\"\n },\n {\n \"starts_at_time\": \"18:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"22:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:01:25.455Z\"\n },\n {\n \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekend Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"08:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"23:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:02:19.952Z\"\n }\n ],\n \"thermostat_weekly_program\": null\n },\n \"warnings\": [],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->list(limit: 10);\n\n// [\n [\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"active_climate_preset\" => [\n \"can_delete\" => true,\n \"can_edit\" => true,\n \"climate_preset_key\" => \"sleep\",\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n ],\n \"appearance\" => [\"name\" => \"Living Room\"],\n \"available_climate_presets\" => [\n [\n \"climate_preset_key\" => \"sleep\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Sleep\",\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"home\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Home\",\n \"display_name\" => \"Home\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"work\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Work\",\n \"display_name\" => \"Work\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n ],\n \"available_fan_mode_settings\" => [\"auto\", \"on\"],\n \"available_hvac_mode_settings\" => [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\",\n ],\n \"current_climate_setting\" => [\n \"display_name\" => \"Manual Setting\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 25,\n \"heating_set_point_fahrenheit\" => 77,\n \"hvac_mode_setting\" => \"heat\",\n \"manual_override_allowed\" => true,\n ],\n \"ecobee_metadata\" => [\n \"device_name\" => \"Living Room\",\n \"ecobee_device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n ],\n \"fallback_climate_preset_key\" => \"eco\",\n \"fan_mode_setting\" => \"auto\",\n \"has_direct_power\" => true,\n \"image_alt_text\" => \"Ecobee 3 Lite Thermostat\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\" => false,\n \"is_fan_running\" => false,\n \"is_heating\" => false,\n \"is_temporary_manual_override_active\" => false,\n \"manufacturer\" => \"ecobee\",\n \"max_cooling_set_point_celsius\" => 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\" => 92,\n \"max_heating_set_point_celsius\" => 26.11111111111111,\n \"max_heating_set_point_fahrenheit\" => 79,\n \"min_cooling_set_point_celsius\" => 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\" => 65,\n \"min_heating_cooling_delta_celsius\" => 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\" => 5,\n \"min_heating_set_point_celsius\" => 7.222222222222222,\n \"min_heating_set_point_fahrenheit\" => 45,\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Ecobee\",\n ],\n \"name\" => \"Living Room\",\n \"online\" => true,\n \"relative_humidity\" => 0.36,\n \"temperature_celsius\" => 21.11111111111111,\n \"temperature_fahrenheit\" => 70,\n \"temperature_threshold\" => [\n \"lower_limit_celsius\" => 16.66666666666667,\n \"lower_limit_fahrenheit\" => 62,\n \"upper_limit_celsius\" => 26.66666666666667,\n \"upper_limit_fahrenheit\" => 80,\n ],\n \"thermostat_daily_programs\" => [\n [\n \"thermostat_daily_program_id\" =>\n \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"07:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"09:00:00\",\n \"climate_preset_key\" => \"work\",\n ],\n [\n \"starts_at_time\" => \"18:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"22:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:01:25.455Z\",\n ],\n [\n \"thermostat_daily_program_id\" =>\n \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekend Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"08:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"23:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:02:19.952Z\",\n ],\n ],\n \"thermostat_weekly_program\" => null,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats list --limit 10\n\n# [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]" } ] } }, "/thermostats/off": { "post": { "description": "Sets a specified [thermostat](/capability-guides/thermostats) to [\"off\" mode](/capability-guides/thermostats/configure-current-climate-settings).", "operationId": "thermostatsOffPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device that you want to set to off mode.", "format": "uuid", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_HVAC_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set to Off Mode", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_HVAC_MODE", "x-response-key": "action_attempt", "x-title": "Set to Off Mode", "x-mint": { "href": "/api/thermostats/off" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.off({\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n});\n\n/*\n{\n \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\": \"SET_HVAC_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/off\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\");\n\n// [\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats off --device_id \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\"\n\n# {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/schedules/create": { "post": { "description": "Creates a new [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSchedulesCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.", "type": "string" }, "device_id": { "description": "ID of the thermostat device for which you want to create a schedule.", "type": "string" }, "ends_at": { "description": "Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "max_override_period_minutes": { "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "exclusiveMinimum": true, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "description": "Name of the thermostat schedule.", "type": "string" }, "starts_at": { "description": "Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" } }, "required": [ "device_id", "climate_preset_key", "starts_at", "ends_at" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" } }, "required": [ "thermostat_schedule" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] }, { "api_key": [] } ], "summary": "Create a Thermostat Schedule", "tags": [ "/thermostats" ], "x-response-key": "thermostat_schedule", "x-title": "Create a Thermostat Schedule", "x-mint": { "href": "/api/thermostats/schedules/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.schedules.create({\n device_id: \"d710aa35-232d-442b-a817-c28045de1c74\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-19T15:00:00.000Z\",\n ends_at: \"2025-06-22T11:00:00.000Z\",\n is_override_allowed: true,\n});\n\n/*\n{\n \"climate_preset_key\": \"Occupied\",\n \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n \"device_id\": \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"ends_at\": \"2025-06-22T11:00:00.000Z\",\n \"errors\": [],\n \"is_override_allowed\": true,\n \"max_override_period_minutes\": 90,\n \"name\": \"Jane's Stay\",\n \"starts_at\": \"2025-06-22T11:00:00.000Z\",\n \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"ends_at\" => \"2025-06-22T11:00:00.000Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-06-22T11:00:00.000Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->schedules->create(\n device_id: \"d710aa35-232d-442b-a817-c28045de1c74\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-19T15:00:00.000Z\",\n ends_at: \"2025-06-22T11:00:00.000Z\",\n is_override_allowed: true,\n);\n\n// [\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"ends_at\" => \"2025-06-22T11:00:00.000Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-06-22T11:00:00.000Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats schedules create --device_id \"d710aa35-232d-442b-a817-c28045de1c74\" --name \"Jane's Stay\" --climate_preset_key \"Occupied\" --max_override_period_minutes 90 --starts_at \"2025-06-19T15:00:00.000Z\" --ends_at \"2025-06-22T11:00:00.000Z\" --is_override_allowed true\n\n# {\n# \"climate_preset_key\": \"Occupied\",\n# \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n# \"device_id\": \"d710aa35-232d-442b-a817-c28045de1c74\",\n# \"ends_at\": \"2025-06-22T11:00:00.000Z\",\n# \"errors\": [],\n# \"is_override_allowed\": true,\n# \"max_override_period_minutes\": 90,\n# \"name\": \"Jane's Stay\",\n# \"starts_at\": \"2025-06-22T11:00:00.000Z\",\n# \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n# \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n# }" } ] } }, "/thermostats/schedules/delete": { "delete": { "description": "Deletes a [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSchedulesDeleteDelete", "parameters": [ { "in": "query", "name": "thermostat_schedule_id", "required": true, "schema": { "description": "ID of the thermostat schedule that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/schedules/delete", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats", "schedules" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Thermostat Schedule" }, "post": { "description": "Deletes a [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSchedulesDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "thermostat_schedule_id": { "description": "ID of the thermostat schedule that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Delete a Thermostat Schedule", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Delete a Thermostat Schedule", "x-mint": { "href": "/api/thermostats/schedules/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.schedules.delete({\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->schedules->delete(\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats schedules delete --thermostat_schedule_id \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\"\n\n# {}" } ] } }, "/thermostats/schedules/get": { "get": { "description": "Returns a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesGetGet", "parameters": [ { "in": "query", "name": "thermostat_schedule_id", "required": true, "schema": { "description": "ID of the thermostat schedule that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" } }, "required": [ "thermostat_schedule", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/schedules/get", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats", "schedules" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "thermostat_schedule", "x-response-key": "thermostat_schedule", "x-title": "Get a Thermostat Schedule" }, "post": { "description": "Returns a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "thermostat_schedule_id": { "description": "ID of the thermostat schedule that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thermostat_schedule": { "$ref": "#/components/schemas/thermostat_schedule" } }, "required": [ "thermostat_schedule" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Get a Thermostat Schedule", "tags": [ "/thermostats" ], "x-response-key": "thermostat_schedule", "x-title": "Get a Thermostat Schedule", "x-mint": { "href": "/api/thermostats/schedules/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.schedules.get({\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n});\n\n/*\n{\n \"climate_preset_key\": \"Occupied\",\n \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n \"device_id\": \"dc1dfc4b-8082-453f-a953-276941af8650\",\n \"ends_at\": \"2025-07-14T16:54:17.946313Z\",\n \"errors\": [],\n \"is_override_allowed\": true,\n \"max_override_period_minutes\": 90,\n \"name\": \"Jane's Stay\",\n \"starts_at\": \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\": \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->schedules->get(\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n);\n\n// [\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats schedules get --thermostat_schedule_id \"408f3f85-11ae-4111-bec1-0f2408a2b218\"\n\n# {\n# \"climate_preset_key\": \"Occupied\",\n# \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n# \"device_id\": \"dc1dfc4b-8082-453f-a953-276941af8650\",\n# \"ends_at\": \"2025-07-14T16:54:17.946313Z\",\n# \"errors\": [],\n# \"is_override_allowed\": true,\n# \"max_override_period_minutes\": 90,\n# \"name\": \"Jane's Stay\",\n# \"starts_at\": \"2025-07-12T16:54:17.946313Z\",\n# \"thermostat_schedule_id\": \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n# \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n# }" } ] } }, "/thermostats/schedules/list": { "get": { "description": "Returns a list of all [thermostat schedules](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSchedulesListGet", "parameters": [ { "in": "query", "name": "device_id", "required": true, "schema": { "description": "ID of the thermostat device for which you want to list schedules.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "user_identifier_key", "required": false, "schema": { "description": "User identifier key by which to filter the list of returned thermostat schedules.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "thermostat_schedules": { "items": { "$ref": "#/components/schemas/thermostat_schedule" }, "type": "array" } }, "required": [ "thermostat_schedules", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/thermostats/schedules/list", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats", "schedules" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "thermostat_schedules", "x-response-key": "thermostat_schedules", "x-title": "List Thermostat Schedules" }, "post": { "description": "Returns a list of all [thermostat schedules](/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSchedulesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to list schedules.", "format": "uuid", "type": "string" }, "user_identifier_key": { "description": "User identifier key by which to filter the list of returned thermostat schedules.", "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thermostat_schedules": { "items": { "$ref": "#/components/schemas/thermostat_schedule" }, "type": "array" } }, "required": [ "thermostat_schedules" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "List Thermostat Schedules", "tags": [ "/thermostats" ], "x-response-key": "thermostat_schedules", "x-title": "List Thermostat Schedules", "x-mint": { "href": "/api/thermostats/schedules/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.schedules.list({\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n});\n\n/*\n[\n {\n \"climate_preset_key\": \"Eco\",\n \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n \"device_id\": \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n \"ends_at\": \"2025-07-14T16:54:17.946313Z\",\n \"errors\": [],\n \"is_override_allowed\": true,\n \"max_override_period_minutes\": 90,\n \"name\": \"Unoccupied\",\n \"starts_at\": \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"climate_preset_key\" => \"Eco\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Unoccupied\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->schedules->list(\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n);\n\n// [\n [\n \"climate_preset_key\" => \"Eco\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Unoccupied\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats schedules list --device_id \"b5d58842-32be-46d2-b161-26787a0bd5ea\"\n\n# [\n# {\n# \"climate_preset_key\": \"Eco\",\n# \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n# \"device_id\": \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n# \"ends_at\": \"2025-07-14T16:54:17.946313Z\",\n# \"errors\": [],\n# \"is_override_allowed\": true,\n# \"max_override_period_minutes\": 90,\n# \"name\": \"Unoccupied\",\n# \"starts_at\": \"2025-07-12T16:54:17.946313Z\",\n# \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n# \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n# }\n# ]" } ] } }, "/thermostats/schedules/update": { "patch": { "description": "Updates a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.", "type": "string" }, "ends_at": { "description": "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "max_override_period_minutes": { "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "exclusiveMinimum": true, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "description": "Name of the thermostat schedule.", "type": "string" }, "starts_at": { "description": "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "thermostat_schedule_id": { "description": "ID of the thermostat schedule that you want to update.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/thermostats/schedules/update", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats", "schedules" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Thermostat Schedule" }, "post": { "description": "Updates a specified [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "operationId": "thermostatsSchedulesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Key of the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.", "type": "string" }, "ends_at": { "description": "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "is_override_allowed": { "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "max_override_period_minutes": { "description": "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "exclusiveMinimum": true, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "description": "Name of the thermostat schedule.", "type": "string" }, "starts_at": { "description": "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "type": "string" }, "thermostat_schedule_id": { "description": "ID of the thermostat schedule that you want to update.", "format": "uuid", "type": "string" } }, "required": [ "thermostat_schedule_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update a Thermostat Schedule", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Update a Thermostat Schedule", "x-mint": { "href": "/api/thermostats/schedules/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.schedules.update({\n thermostat_schedule_id: \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-20T03:24:25.000Z\",\n ends_at: \"2025-06-22T06:04:21.000Z\",\n is_override_allowed: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->schedules->update(\n thermostat_schedule_id: \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-20T03:24:25.000Z\",\n ends_at: \"2025-06-22T06:04:21.000Z\",\n is_override_allowed: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats schedules update --thermostat_schedule_id \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\" --name \"Jane's Stay\" --climate_preset_key \"Occupied\" --max_override_period_minutes 90 --starts_at \"2025-06-20T03:24:25.000Z\" --ends_at \"2025-06-22T06:04:21.000Z\" --is_override_allowed true\n\n# {}" } ] } }, "/thermostats/set_fallback_climate_preset": { "post": { "description": "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).", "operationId": "thermostatsSetFallbackClimatePresetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Climate preset key of the climate preset that you want to set as the fallback climate preset.", "type": "string" }, "device_id": { "description": "ID of the thermostat device for which you want to set the fallback climate preset.", "format": "uuid", "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set the Fallback Climate Preset", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Set the Fallback Climate Preset", "x-mint": { "href": "/api/thermostats/set_fallback_climate_preset" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.setFallbackClimatePreset({\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fallback_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->set_fallback_climate_preset(\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats set-fallback-climate-preset --device_id \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\" --climate_preset_key \"Eco\"\n\n# {}" } ] } }, "/thermostats/set_fan_mode": { "post": { "description": "Sets the [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSetFanModePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set the fan mode.", "format": "uuid", "type": "string" }, "fan_mode": { "deprecated": true, "description": "Deprecated. Use `fan_mode_setting` instead.\n\nFan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "fan_mode_setting": { "description": "[Fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.", "enum": [ "auto", "on", "circulate" ], "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_FAN_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set the Fan Mode Setting", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_FAN_MODE", "x-response-key": "action_attempt", "x-title": "Set the Fan Mode Setting", "x-mint": { "href": "/api/thermostats/set_fan_mode" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.setFanMode({\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n});\n\n/*\n{\n \"action_attempt_id\": \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n \"action_type\": \"SET_FAN_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fan_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n \"action_type\" => \"SET_FAN_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->set_fan_mode(\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n);\n\n// [\n \"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n \"action_type\" => \"SET_FAN_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats set-fan-mode --device_id \"363e657e-3b07-4670-a290-7fb1f32b8e33\" --fan_mode_setting \"auto\"\n\n# {\n# \"action_attempt_id\": \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n# \"action_type\": \"SET_FAN_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/set_hvac_mode": { "post": { "description": "Sets the [HVAC mode](/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsSetHvacModePost", "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "propertyName": "hvac_mode_setting" }, "oneOf": [ { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set the HVAC mode.", "format": "uuid", "type": "string" }, "hvac_mode_setting": { "enum": [ "off" ], "type": "string" } }, "required": [ "hvac_mode_setting", "device_id" ], "type": "object" }, { "properties": { "cooling_set_point_celsius": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to set the HVAC mode.", "format": "uuid", "type": "string" }, "hvac_mode_setting": { "enum": [ "cool" ], "type": "string" } }, "required": [ "hvac_mode_setting", "device_id" ], "type": "object" }, { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set the HVAC mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "hvac_mode_setting": { "enum": [ "heat" ], "type": "string" } }, "required": [ "hvac_mode_setting", "device_id" ], "type": "object" }, { "properties": { "cooling_set_point_celsius": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "[Cooling set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to set the HVAC mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "[Heating set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.", "format": "float", "type": "number" }, "hvac_mode_setting": { "enum": [ "heat_cool" ], "type": "string" } }, "required": [ "hvac_mode_setting", "device_id" ], "type": "object" }, { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set the HVAC mode.", "format": "uuid", "type": "string" }, "hvac_mode_setting": { "enum": [ "eco" ], "type": "string" } }, "required": [ "hvac_mode_setting", "device_id" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "SET_HVAC_MODE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Set the HVAC Mode", "tags": [ "/thermostats" ], "x-action-attempt-type": "SET_HVAC_MODE", "x-response-key": "action_attempt", "x-title": "Set the HVAC Mode", "x-mint": { "href": "/api/thermostats/set_hvac_mode" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.setHvacMode({\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});\n\n/*\n{\n \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\": \"SET_HVAC_MODE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_hvac_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->set_hvac_mode(\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n);\n\n// [\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats set-hvac-mode --device_id \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\" --hvac_mode_setting \"heat_cool\" --heating_set_point_celsius 20 --cooling_set_point_celsius 25\n\n# {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/thermostats/set_temperature_threshold": { "patch": { "description": "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.", "operationId": "thermostatsSetTemperatureThresholdPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set a temperature threshold.", "format": "uuid", "type": "string" }, "lower_limit_celsius": { "default": null, "description": "Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "lower_limit_fahrenheit": { "default": null, "description": "Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_celsius": { "default": null, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_fahrenheit": { "default": null, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.", "format": "float", "nullable": true, "type": "number" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/thermostats/set_temperature_threshold", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats" ], "x-fern-sdk-method-name": "set_temperature_threshold", "x-response-key": null, "x-title": "Set a Temperature Threshold" }, "post": { "description": "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.", "operationId": "thermostatsSetTemperatureThresholdPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to set a temperature threshold.", "format": "uuid", "type": "string" }, "lower_limit_celsius": { "default": null, "description": "Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "lower_limit_fahrenheit": { "default": null, "description": "Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_celsius": { "default": null, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.", "format": "float", "nullable": true, "type": "number" }, "upper_limit_fahrenheit": { "default": null, "description": "Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.", "format": "float", "nullable": true, "type": "number" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Set a Temperature Threshold", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Set a Temperature Threshold", "x-mint": { "href": "/api/thermostats/set_temperature_threshold" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.setTemperatureThreshold({\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_temperature_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->set_temperature_threshold(\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats set-temperature-threshold --device_id \"a9b52627-e6e2-4beb-9168-964749f7bbae\" --lower_limit_fahrenheit 60 --upper_limit_fahrenheit 80\n\n# {}" } ] } }, "/thermostats/simulate/hvac_mode_adjusted": { "post": { "description": "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 Simulate Endpoints](/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).", "operationId": "thermostatsSimulateHvacModeAdjustedPost", "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "propertyName": "hvac_mode" }, "oneOf": [ { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.", "format": "uuid", "type": "string" }, "hvac_mode": { "description": "HVAC mode that you want to simulate.", "enum": [ "off" ], "type": "string" } }, "required": [ "hvac_mode", "device_id" ], "type": "object" }, { "properties": { "cooling_set_point_celsius": { "description": "Cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.", "format": "uuid", "type": "string" }, "hvac_mode": { "description": "HVAC mode that you want to simulate.", "enum": [ "cool" ], "type": "string" } }, "required": [ "hvac_mode", "device_id" ], "type": "object" }, { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "Heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.", "format": "float", "type": "number" }, "hvac_mode": { "description": "HVAC mode that you want to simulate.", "enum": [ "heat" ], "type": "string" } }, "required": [ "hvac_mode", "device_id" ], "type": "object" }, { "properties": { "cooling_set_point_celsius": { "description": "Cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Cooling [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.", "format": "uuid", "type": "string" }, "heating_set_point_celsius": { "description": "Heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.", "format": "float", "type": "number" }, "hvac_mode": { "description": "HVAC mode that you want to simulate.", "enum": [ "heat_cool" ], "type": "string" } }, "required": [ "hvac_mode", "device_id" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "HVAC Mode Adjusted", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "HVAC Mode Adjusted", "x-mint": { "href": "/api/thermostats/simulate/hvac_mode_adjusted" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.simulate.hvacModeAdjusted({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/hvac_mode_adjusted\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->simulate->hvac_mode_adjusted(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats simulate hvac-mode-adjusted --device_id \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\" --hvac_mode \"heat\" --heating_set_point_fahrenheit 68\n\n# {}" } ] } }, "/thermostats/simulate/temperature_reached": { "post": { "description": "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-with-simulate-endpoints).", "operationId": "thermostatsSimulateTemperatureReachedPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device that you want to simulate reaching a specified temperature.", "format": "uuid", "type": "string" }, "temperature_celsius": { "description": "Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.", "format": "float", "type": "number" }, "temperature_fahrenheit": { "description": "Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.", "format": "float", "type": "number" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Temperature Reached", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Temperature Reached", "x-mint": { "href": "/api/thermostats/simulate/temperature_reached" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.simulate.temperatureReached({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/temperature_reached\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->simulate->temperature_reached(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats simulate temperature-reached --device_id \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\" --temperature_celsius 25\n\n# {}" } ] } }, "/thermostats/update_climate_preset": { "patch": { "description": "Updates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsUpdateClimatePresetPatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to update a climate preset.", "format": "uuid", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session": [] } ], "summary": "/thermostats/update_climate_preset", "tags": [ "/thermostats" ], "x-fern-sdk-group-name": [ "thermostats" ], "x-fern-sdk-method-name": "update_climate_preset", "x-response-key": null, "x-title": "Update a Climate Preset" }, "post": { "description": "Updates a specified [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](/capability-guides/thermostats).", "operationId": "thermostatsUpdateClimatePresetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "climate_preset_key": { "description": "Unique key to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "type": "string" }, "climate_preset_mode": { "description": "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ", "enum": [ "home", "away", "wake", "sleep", "occupied", "unoccupied" ], "type": "string" }, "cooling_set_point_celsius": { "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "cooling_set_point_fahrenheit": { "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "device_id": { "description": "ID of the thermostat device for which you want to update a climate preset.", "format": "uuid", "type": "string" }, "ecobee_metadata": { "description": "\n Metadata specific to the Ecobee climate, if applicable.\n ", "properties": { "climate_ref": { "description": "Reference to the Ecobee climate, if applicable.", "type": "string" }, "is_optimized": { "description": "Indicates if the climate preset is optimized by Ecobee.", "type": "boolean" }, "owner": { "description": "Indicates whether the climate preset is owned by the user or the system.", "enum": [ "user", "system" ], "type": "string" } }, "type": "object" }, "fan_mode_setting": { "description": "Desired [fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], "type": "string" }, "heating_set_point_celsius": { "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "heating_set_point_fahrenheit": { "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).", "format": "float", "type": "number" }, "hvac_mode_setting": { "description": "Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", "enum": [ "off", "heat", "cool", "heat_cool", "eco" ], "type": "string" }, "manual_override_allowed": { "deprecated": true, "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", "type": "boolean" }, "name": { "default": null, "description": "User-friendly name to identify the [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets).", "nullable": true, "type": "string" } }, "required": [ "device_id", "climate_preset_key" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] }, { "client_session": [] } ], "summary": "Update a Climate Preset", "tags": [ "/thermostats" ], "x-response-key": null, "x-title": "Update a Climate Preset", "x-mint": { "href": "/api/thermostats/update_climate_preset" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.updateClimatePreset({\n device_id: \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\",\n climate_preset_key: \"Home\",\n name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 65,\n manual_override_allowed: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->update_climate_preset(\n device_id: \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\",\n climate_preset_key: \"Home\",\n name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 65,\n manual_override_allowed: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats update-climate-preset --device_id \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\" --climate_preset_key \"Home\" --name \"Home\" --fan_mode_setting \"auto\" --hvac_mode_setting \"heat_cool\" --cooling_set_point_fahrenheit 75 --heating_set_point_fahrenheit 65 --manual_override_allowed true\n\n# {}" } ] } }, "/thermostats/update_weekly_program": { "post": { "description": "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 thermostat.", "operationId": "thermostatsUpdateWeeklyProgramPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the thermostat device for which you want to update the weekly program.", "format": "uuid", "type": "string" }, "friday_program_id": { "description": "ID of the thermostat daily program to run on Fridays.", "format": "uuid", "nullable": true, "type": "string" }, "monday_program_id": { "description": "ID of the thermostat daily program to run on Mondays.", "format": "uuid", "nullable": true, "type": "string" }, "saturday_program_id": { "description": "ID of the thermostat daily program to run on Saturdays.", "format": "uuid", "nullable": true, "type": "string" }, "sunday_program_id": { "description": "ID of the thermostat daily program to run on Sundays.", "format": "uuid", "nullable": true, "type": "string" }, "thursday_program_id": { "description": "ID of the thermostat daily program to run on Thursdays.", "format": "uuid", "nullable": true, "type": "string" }, "tuesday_program_id": { "description": "ID of the thermostat daily program to run on Tuesdays.", "format": "uuid", "nullable": true, "type": "string" }, "wednesday_program_id": { "description": "ID of the thermostat daily program to run on Wednesdays.", "format": "uuid", "nullable": true, "type": "string" } }, "required": [ "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "PUSH_THERMOSTAT_PROGRAMS" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update the Thermostat Weekly Program", "tags": [ "/thermostats" ], "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS", "x-response-key": "action_attempt", "x-title": "Update the Thermostat Weekly Program", "x-mint": { "href": "/api/thermostats/update_weekly_program" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.thermostats.updateWeeklyProgram({\n device_id: \"076546e8-966c-47dd-831b-8d98413bf070\",\n monday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n tuesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n wednesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n thursday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n friday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n saturday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n sunday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n});\n\n/*\n{\n \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_weekly_program\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->thermostats->update_weekly_program(\n device_id: \"076546e8-966c-47dd-831b-8d98413bf070\",\n monday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n tuesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n wednesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n thursday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n friday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n saturday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n sunday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n);\n\n// [\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam thermostats update-weekly-program --device_id \"076546e8-966c-47dd-831b-8d98413bf070\" --monday_program_id \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\" --tuesday_program_id \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\" --wednesday_program_id \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\" --thursday_program_id \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\" --friday_program_id \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\" --saturday_program_id \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\" --sunday_program_id \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\"\n\n# {\n# \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/user_identities/add_acs_user": { "post": { "description": "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).\n\nYou must specify either `user_identity_id` or `user_identity_key` to identify the user identity.\n\nIf `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.", "operationId": "userIdentitiesAddAcsUserPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_user_id": { "description": "ID of the access system user that you want to add to the user identity.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to which you want to add an access system user.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Key of the user identity to which you want to add an access system user.", "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Add an ACS User to a User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Add an ACS User to a User Identity", "x-mint": { "href": "/api/user_identities/add_acs_user" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.addAcsUser({\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/add_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->add_acs_user(\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities add-acs-user --user_identity_id \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\" --acs_user_id \"d73f4706-67e3-419d-899e-ec957a75ee0c\"\n\n# {}" } ] }, "put": { "description": "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).\n\nYou must specify either `user_identity_id` or `user_identity_key` to identify the user identity.\n\nIf `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.", "operationId": "userIdentitiesAddAcsUserPut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_user_id": { "description": "ID of the access system user that you want to add to the user identity.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity to which you want to add an access system user.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Key of the user identity to which you want to add an access system user.", "type": "string" } }, "required": [ "acs_user_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/add_acs_user", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "add_acs_user", "x-response-key": null, "x-title": "Add an ACS User to a User Identity" } }, "/user_identities/create": { "post": { "description": "Creates a new [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_system_ids": { "description": "List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "email_address": { "description": "Unique email address for the new user identity.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the user associated with the new user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the new user identity in E.164 format (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_key": { "description": "Unique key for the new user identity.", "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user_identity": { "$ref": "#/components/schemas/user_identity" } }, "required": [ "user_identity" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Create a User Identity", "tags": [ "/user_identities" ], "x-response-key": "user_identity", "x-title": "Create a User Identity", "x-mint": { "href": "/api/user_identities/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.create({\n user_identity_key: \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n acs_system_ids: [\"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"],\n});\n\n/*\n{\n \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"full_name\": \"Jane Doe\",\n \"phone_number\": \"+15551234567\",\n \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\": \"jane_doe\",\n \"warnings\": [],\n \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+15551234567\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->create(\n user_identity_key: \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n acs_system_ids: [\"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"],\n);\n\n// [\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+15551234567\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities create --user_identity_key \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\" --email_address \"jane@example.com\" --phone_number \"+15551234567\" --full_name \"Jane Doe\" --acs_system_ids [\"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"]\n\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+15551234567\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }" } ] } }, "/user_identities/delete": { "delete": { "description": "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/object) and [client sessions](/api/client_sessions/object).", "operationId": "userIdentitiesDeleteDelete", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity that you want to delete.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/delete", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a User Identity" }, "post": { "description": "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/object) and [client sessions](/api/client_sessions/object).", "operationId": "userIdentitiesDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity that you want to delete.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete a User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Delete a User Identity", "x-mint": { "href": "/api/user_identities/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.delete({\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->delete(\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities delete --user_identity_id \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\"\n\n# {}" } ] } }, "/user_identities/generate_instant_key": { "post": { "description": "Generates a new [instant key](/capability-guides/instant-keys) for a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGenerateInstantKeyPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "customization_profile_id": { "format": "uuid", "type": "string" }, "max_use_count": { "default": 1, "description": "Maximum number of times the instant key can be used. Default: 1.", "format": "float", "type": "number" }, "user_identity_id": { "description": "ID of the user identity for which you want to generate an instant key.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "instant_key": { "$ref": "#/components/schemas/instant_key" } }, "required": [ "instant_key" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Generate an Instant Key", "tags": [ "/user_identities" ], "x-response-key": "instant_key", "x-title": "Generate an Instant Key", "x-mint": { "href": "/api/user_identities/generate_instant_key" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.generateInstantKey({\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n});\n\n/*\n{\n \"client_session_id\": \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n \"created_at\": \"2025-06-14T16:54:17.946559Z\",\n \"expires_at\": \"2025-06-16T16:54:17.946559Z\",\n \"instant_key_id\": \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n \"user_identity_id\": \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"workspace_id\": \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n \"created_at\" => \"2025-06-14T16:54:17.946559Z\",\n \"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\n \"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->generate_instant_key(\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n);\n\n// [\n \"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n \"created_at\" => \"2025-06-14T16:54:17.946559Z\",\n \"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\n \"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities generate-instant-key --user_identity_id \"d92e0c7b-72a1-4063-9ee8-2acefc240358\" --max_use_count 10\n\n# {\n# \"client_session_id\": \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n# \"created_at\": \"2025-06-14T16:54:17.946559Z\",\n# \"expires_at\": \"2025-06-16T16:54:17.946559Z\",\n# \"instant_key_id\": \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"user_identity_id\": \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n# \"workspace_id\": \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\"\n# }" } ] } }, "/user_identities/get": { "get": { "description": "Returns a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGetGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "user_identity": { "$ref": "#/components/schemas/user_identity" } }, "required": [ "user_identity", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "/user_identities/get", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity", "x-response-key": "user_identity", "x-title": "Get a User Identity" }, "post": { "description": "Returns a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesGetPost", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "user_identity_id": { "description": "ID of the user identity that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" }, { "properties": { "user_identity_key": { "type": "string" } }, "required": [ "user_identity_key" ], "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user_identity": { "$ref": "#/components/schemas/user_identity" } }, "required": [ "user_identity" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "client_session_with_customer": [] } ], "summary": "Get a User Identity", "tags": [ "/user_identities" ], "x-response-key": "user_identity", "x-title": "Get a User Identity", "x-mint": { "href": "/api/user_identities/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.get({\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n});\n\n/*\n{\n \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"full_name\": \"Jane Doe\",\n \"phone_number\": \"+1555551002\",\n \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\": \"jane_doe\",\n \"warnings\": [],\n \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->get(\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n);\n\n// [\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities get --user_identity_id \"43947360-cdc8-4db6-8b22-e079416d1d8b\"\n\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+1555551002\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }" } ] } }, "/user_identities/grant_access_to_device": { "post": { "description": "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).", "operationId": "userIdentitiesGrantAccessToDevicePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the managed device to which you want to grant access to the user identity.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to grant access to a device.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Grant a User Identity Access to a Device", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Grant a User Identity Access to a Device", "x-mint": { "href": "/api/user_identities/grant_access_to_device" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.grantAccessToDevice({\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/grant_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->grant_access_to_device(\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities grant-access-to-device --user_identity_id \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\" --device_id \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\"\n\n# {}" } ] }, "put": { "description": "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).", "operationId": "userIdentitiesGrantAccessToDevicePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the managed device to which you want to grant access to the user identity.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to grant access to a device.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/grant_access_to_device", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "grant_access_to_device", "x-response-key": null, "x-title": "Grant a User Identity Access to a Device" } }, "/user_identities/list": { "get": { "description": "Returns a list of all [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListGet", "parameters": [ { "in": "query", "name": "user_identity_ids", "schema": { "description": "Array of user identity IDs by which to filter the list of user identities.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.", "type": "string" } }, { "in": "query", "name": "credential_manager_acs_system_id", "schema": { "description": "`acs_system_id` of the credential manager by which you want to filter the list of user identities.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" }, "user_identities": { "items": { "$ref": "#/components/schemas/user_identity" }, "type": "array" } }, "required": [ "user_identities", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/list", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities", "x-response-key": "user_identities", "x-title": "List User Identities" }, "post": { "description": "Returns a list of all [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "created_before": { "description": "Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.", "format": "date-time", "type": "string" }, "credential_manager_acs_system_id": { "description": "`acs_system_id` of the credential manager by which you want to filter the list of user identities.", "format": "uuid", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.", "type": "string" }, "user_identity_ids": { "description": "Array of user identity IDs by which to filter the list of user identities.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pagination": { "$ref": "#/components/schemas/pagination" }, "user_identities": { "items": { "$ref": "#/components/schemas/user_identity" }, "type": "array" } }, "required": [ "user_identities", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List User Identities", "tags": [ "/user_identities" ], "x-response-key": "user_identities", "x-title": "List User Identities", "x-mint": { "href": "/api/user_identities/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.list();\n\n/*\n[\n {\n \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"full_name\": \"Jane Doe\",\n \"phone_number\": \"+1555551002\",\n \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\": \"jane_doe\",\n \"warnings\": [],\n \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"user_identities\": [\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+1555551002\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.user_identities.list()\n\n# [\n UserIdentity(\n created_at=\"2025-06-16T16:54:17.946546Z\",\n display_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n errors=[],\n full_name=\"Jane Doe\",\n phone_number=\"+1555551002\",\n user_identity_id=\"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n user_identity_key=\"jane_doe\",\n warnings=[],\n workspace_id=\"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.user_identities.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->list();\n\n// [\n [\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities list\n\n# [\n# {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+1555551002\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }\n# ]" } ] } }, "/user_identities/list_accessible_devices": { "get": { "description": "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 devices directly linked to the user identity.", "operationId": "userIdentitiesListAccessibleDevicesGet", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity for which you want to retrieve all accessible devices.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accessible_devices": { "deprecated": true, "items": { "$ref": "#/components/schemas/device" }, "type": "array", "description": "Deprecated. Use devices." }, "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "devices", "accessible_devices", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/list_accessible_devices", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "list_accessible_devices", "x-fern-sdk-return-value": "devices", "x-response-key": "devices", "x-title": "List Accessible Devices for a User Identity" }, "post": { "description": "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 devices directly linked to the user identity.", "operationId": "userIdentitiesListAccessibleDevicesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all accessible devices.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/device" }, "type": "array" } }, "required": [ "devices" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Accessible Devices for a User Identity", "tags": [ "/user_identities" ], "x-response-key": "devices", "x-title": "List Accessible Devices for a User Identity", "x-mint": { "href": "/api/user_identities/list_accessible_devices" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.listAccessibleDevices({\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n});\n\n/*\n[\n {\n \"can_hvac_cool\": true,\n \"can_hvac_heat\": true,\n \"can_hvac_heat_cool\": true,\n \"can_turn_off_hvac\": true,\n \"capabilities_supported\": [\n \"thermostat\"\n ],\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\": \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n },\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\": \"ecobee_thermostat\",\n \"display_name\": \"Living Room\",\n \"errors\": [],\n \"is_managed\": true,\n \"location\": {\n \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\": \"America/Los_Angeles\"\n },\n \"nickname\": \"Living Room\",\n \"properties\": {\n \"active_climate_preset\": {\n \"can_delete\": true,\n \"can_edit\": true,\n \"climate_preset_key\": \"sleep\",\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 17.77777777777778,\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true\n },\n \"appearance\": {\n \"name\": \"Living Room\"\n },\n \"available_climate_presets\": [\n {\n \"climate_preset_key\": \"sleep\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Sleep\",\n \"display_name\": \"Sleep\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"home\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Home\",\n \"display_name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n },\n {\n \"climate_preset_key\": \"work\",\n \"can_edit\": true,\n \"can_delete\": true,\n \"can_use_with_thermostat_daily_programs\": false,\n \"name\": \"Work\",\n \"display_name\": \"Work\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": false,\n \"cooling_set_point_celsius\": 23.88888888888889,\n \"heating_set_point_celsius\": 17.77777777777778,\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 64\n }\n ],\n \"available_fan_mode_settings\": [\n \"auto\",\n \"on\"\n ],\n \"available_hvac_mode_settings\": [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\"\n ],\n \"current_climate_setting\": {\n \"display_name\": \"Manual Setting\",\n \"fan_mode_setting\": \"auto\",\n \"heating_set_point_celsius\": 25,\n \"heating_set_point_fahrenheit\": 77,\n \"hvac_mode_setting\": \"heat\",\n \"manual_override_allowed\": true\n },\n \"ecobee_metadata\": {\n \"device_name\": \"Living Room\",\n \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n },\n \"fallback_climate_preset_key\": \"eco\",\n \"fan_mode_setting\": \"auto\",\n \"has_direct_power\": true,\n \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\": false,\n \"is_fan_running\": false,\n \"is_heating\": false,\n \"is_temporary_manual_override_active\": false,\n \"manufacturer\": \"ecobee\",\n \"max_cooling_set_point_celsius\": 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\": 92,\n \"max_heating_set_point_celsius\": 26.11111111111111,\n \"max_heating_set_point_fahrenheit\": 79,\n \"min_cooling_set_point_celsius\": 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\": 65,\n \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\": 5,\n \"min_heating_set_point_celsius\": 7.222222222222222,\n \"min_heating_set_point_fahrenheit\": 45,\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Ecobee\"\n },\n \"name\": \"Living Room\",\n \"online\": true,\n \"relative_humidity\": 0.36,\n \"temperature_celsius\": 21.11111111111111,\n \"temperature_fahrenheit\": 70,\n \"temperature_threshold\": {\n \"lower_limit_celsius\": 16.66666666666667,\n \"lower_limit_fahrenheit\": 62,\n \"upper_limit_celsius\": 26.66666666666667,\n \"upper_limit_fahrenheit\": 80\n },\n \"thermostat_daily_programs\": [\n {\n \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"work\"\n },\n {\n \"starts_at_time\": \"18:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"22:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:01:25.455Z\"\n },\n {\n \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\": \"Weekend Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"00:00:00\",\n \"climate_preset_key\": \"sleep\"\n },\n {\n \"starts_at_time\": \"08:00:00\",\n \"climate_preset_key\": \"home\"\n },\n {\n \"starts_at_time\": \"23:00:00\",\n \"climate_preset_key\": \"sleep\"\n }\n ],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\": \"2025-05-30T04:02:19.952Z\"\n }\n ],\n \"thermostat_weekly_program\": null\n },\n \"warnings\": [],\n \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_accessible_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->list_accessible_devices(\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n);\n\n// [\n [\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => [\n \"location_name\" => \"2948 20th St, San Francisco, CA, 94110, US\",\n \"timezone\" => \"America/Los_Angeles\",\n ],\n \"nickname\" => \"Living Room\",\n \"properties\" => [\n \"active_climate_preset\" => [\n \"can_delete\" => true,\n \"can_edit\" => true,\n \"climate_preset_key\" => \"sleep\",\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n ],\n \"appearance\" => [\"name\" => \"Living Room\"],\n \"available_climate_presets\" => [\n [\n \"climate_preset_key\" => \"sleep\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Sleep\",\n \"display_name\" => \"Sleep\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"home\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Home\",\n \"display_name\" => \"Home\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n [\n \"climate_preset_key\" => \"work\",\n \"can_edit\" => true,\n \"can_delete\" => true,\n \"can_use_with_thermostat_daily_programs\" => false,\n \"name\" => \"Work\",\n \"display_name\" => \"Work\",\n \"fan_mode_setting\" => \"auto\",\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => false,\n \"cooling_set_point_celsius\" => 23.88888888888889,\n \"heating_set_point_celsius\" => 17.77777777777778,\n \"cooling_set_point_fahrenheit\" => 75,\n \"heating_set_point_fahrenheit\" => 64,\n ],\n ],\n \"available_fan_mode_settings\" => [\"auto\", \"on\"],\n \"available_hvac_mode_settings\" => [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\",\n ],\n \"current_climate_setting\" => [\n \"display_name\" => \"Manual Setting\",\n \"fan_mode_setting\" => \"auto\",\n \"heating_set_point_celsius\" => 25,\n \"heating_set_point_fahrenheit\" => 77,\n \"hvac_mode_setting\" => \"heat\",\n \"manual_override_allowed\" => true,\n ],\n \"ecobee_metadata\" => [\n \"device_name\" => \"Living Room\",\n \"ecobee_device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n ],\n \"fallback_climate_preset_key\" => \"eco\",\n \"fan_mode_setting\" => \"auto\",\n \"has_direct_power\" => true,\n \"image_alt_text\" => \"Ecobee 3 Lite Thermostat\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n \"is_cooling\" => false,\n \"is_fan_running\" => false,\n \"is_heating\" => false,\n \"is_temporary_manual_override_active\" => false,\n \"manufacturer\" => \"ecobee\",\n \"max_cooling_set_point_celsius\" => 33.333333333333336,\n \"max_cooling_set_point_fahrenheit\" => 92,\n \"max_heating_set_point_celsius\" => 26.11111111111111,\n \"max_heating_set_point_fahrenheit\" => 79,\n \"min_cooling_set_point_celsius\" => 18.333333333333336,\n \"min_cooling_set_point_fahrenheit\" => 65,\n \"min_heating_cooling_delta_celsius\" => 2.7777777777777777,\n \"min_heating_cooling_delta_fahrenheit\" => 5,\n \"min_heating_set_point_celsius\" => 7.222222222222222,\n \"min_heating_set_point_fahrenheit\" => 45,\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Ecobee\",\n ],\n \"name\" => \"Living Room\",\n \"online\" => true,\n \"relative_humidity\" => 0.36,\n \"temperature_celsius\" => 21.11111111111111,\n \"temperature_fahrenheit\" => 70,\n \"temperature_threshold\" => [\n \"lower_limit_celsius\" => 16.66666666666667,\n \"lower_limit_fahrenheit\" => 62,\n \"upper_limit_celsius\" => 26.66666666666667,\n \"upper_limit_fahrenheit\" => 80,\n ],\n \"thermostat_daily_programs\" => [\n [\n \"thermostat_daily_program_id\" =>\n \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"07:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"09:00:00\",\n \"climate_preset_key\" => \"work\",\n ],\n [\n \"starts_at_time\" => \"18:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"22:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:01:25.455Z\",\n ],\n [\n \"thermostat_daily_program_id\" =>\n \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"name\" => \"Weekend Program\",\n \"periods\" => [\n [\n \"starts_at_time\" => \"00:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n [\n \"starts_at_time\" => \"08:00:00\",\n \"climate_preset_key\" => \"home\",\n ],\n [\n \"starts_at_time\" => \"23:00:00\",\n \"climate_preset_key\" => \"sleep\",\n ],\n ],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n \"created_at\" => \"2025-05-30T04:02:19.952Z\",\n ],\n ],\n \"thermostat_weekly_program\" => null,\n ],\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities list-accessible-devices --user_identity_id \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\"\n\n# [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]" } ] } }, "/user_identities/list_accessible_entrances": { "get": { "description": "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 identity and entrances accessible through ACS users linked to the user identity.", "operationId": "userIdentitiesListAccessibleEntrancesGet", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity for which you want to retrieve all accessible entrances.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_entrances", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/user_identities/list_accessible_entrances", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "list_accessible_entrances", "x-fern-sdk-return-value": "acs_entrances", "x-response-key": "acs_entrances", "x-title": "List Accessible Entrances for a User Identity" }, "post": { "description": "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 identity and entrances accessible through ACS users linked to the user identity.", "operationId": "userIdentitiesListAccessibleEntrancesPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all accessible entrances.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_entrances": { "items": { "$ref": "#/components/schemas/acs_entrance" }, "type": "array" } }, "required": [ "acs_entrances" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List Accessible Entrances for a User Identity", "tags": [ "/user_identities" ], "x-response-key": "acs_entrances", "x-title": "List Accessible Entrances for a User Identity", "x-mint": { "href": "/api/user_identities/list_accessible_entrances" } } }, "/user_identities/list_acs_systems": { "get": { "description": "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).", "operationId": "userIdentitiesListAcsSystemsGet", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity for which you want to retrieve all access systems.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_systems", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/user_identities/list_acs_systems", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "list_acs_systems", "x-fern-sdk-return-value": "acs_systems", "x-response-key": "acs_systems", "x-title": "List ACS Systems Associated with a User Identity" }, "post": { "description": "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).", "operationId": "userIdentitiesListAcsSystemsPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all access systems.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_systems": { "items": { "$ref": "#/components/schemas/acs_system" }, "type": "array" } }, "required": [ "acs_systems" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "List ACS Systems Associated with a User Identity", "tags": [ "/user_identities" ], "x-response-key": "acs_systems", "x-title": "List ACS Systems Associated with a User Identity", "x-mint": { "href": "/api/user_identities/list_acs_systems" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.listAcsSystems({\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n});\n\n/*\n[\n {\n \"acs_access_group_count\": 5,\n \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\": 20,\n \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\": [\n \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n ],\n \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\": [],\n \"external_type\": \"salto_ks_site\",\n \"external_type_display_name\": \"Salto KS site\",\n \"image_alt_text\": \"Salto KS site Logo\",\n \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\": false,\n \"location\": {\n \"time_zone\": \"America/New_York\"\n },\n \"name\": \"My Access System\",\n \"warnings\": [],\n \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->list_acs_systems(\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n);\n\n// [\n [\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" =>\n \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities list-acs-systems --user_identity_id \"77e0347d-35ac-4a21-962b-e757a446b47f\"\n\n# [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]" } ] } }, "/user_identities/list_acs_users": { "get": { "description": "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).", "operationId": "userIdentitiesListAcsUsersGet", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" }, "ok": { "type": "boolean" } }, "required": [ "acs_users", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/list_acs_users", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "list_acs_users", "x-fern-sdk-return-value": "acs_users", "x-response-key": "acs_users", "x-title": "List ACS Users Associated with a User Identity" }, "post": { "description": "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).", "operationId": "userIdentitiesListAcsUsersPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the user identity for which you want to retrieve all access system users.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "acs_users": { "items": { "$ref": "#/components/schemas/acs_user" }, "type": "array" } }, "required": [ "acs_users" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List ACS Users Associated with a User Identity", "tags": [ "/user_identities" ], "x-response-key": "acs_users", "x-title": "List ACS Users Associated with a User Identity", "x-mint": { "href": "/api/user_identities/list_acs_users" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.listAcsUsers({\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n});\n\n/*\n[\n {\n \"access_schedule\": {\n \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n },\n \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n \"display_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"errors\": [],\n \"external_type\": \"salto_site_user\",\n \"external_type_display_name\": \"Salto site user\",\n \"full_name\": \"Jane Doe\",\n \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\": true,\n \"is_suspended\": false,\n \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\": [],\n \"phone_number\": \"+1555551000\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\": \"+1555551000\",\n \"warnings\": [],\n \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->list_acs_users(\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n);\n\n// [\n [\n \"access_schedule\" => [\n \"ends_at\" => \"2025-06-12T11:00:00.000Z\",\n \"starts_at\" => \"2025-06-10T15:00:00.000Z\",\n ],\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities list-acs-users --user_identity_id \"b0dc10f2-3971-440e-af25-dab964e5c281\"\n\n# [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]" } ] } }, "/user_identities/remove_acs_user": { "delete": { "description": "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).", "operationId": "userIdentitiesRemoveAcsUserDelete", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity from which you want to remove an access system user.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "acs_user_id", "required": true, "schema": { "description": "ID of the access system user that you want to remove from the user identity..", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/remove_acs_user", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "remove_acs_user", "x-response-key": null, "x-title": "Remove an ACS User from a User Identity" }, "post": { "description": "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).", "operationId": "userIdentitiesRemoveAcsUserPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "acs_user_id": { "description": "ID of the access system user that you want to remove from the user identity..", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity from which you want to remove an access system user.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "acs_user_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Remove an ACS User from a User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Remove an ACS User from a User Identity", "x-mint": { "href": "/api/user_identities/remove_acs_user" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.removeAcsUser({\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/remove_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->remove_acs_user(\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities remove-acs-user --user_identity_id \"802633b6-a66c-4911-b57b-323e900ee531\" --acs_user_id \"faa22878-fa74-4ea0-87f7-2b05c1b06181\"\n\n# {}" } ] } }, "/user_identities/revoke_access_to_device": { "delete": { "description": "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).", "operationId": "userIdentitiesRevokeAccessToDeviceDelete", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the user identity from which you want to revoke access to a device.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "device_id", "required": true, "schema": { "description": "ID of the managed device to which you want to revoke access from the user identity.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/revoke_access_to_device", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "revoke_access_to_device", "x-response-key": null, "x-title": "Revoke Access to a Device from a User Identity" }, "post": { "description": "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).", "operationId": "userIdentitiesRevokeAccessToDevicePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "device_id": { "description": "ID of the managed device to which you want to revoke access from the user identity.", "format": "uuid", "type": "string" }, "user_identity_id": { "description": "ID of the user identity from which you want to revoke access to a device.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "device_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Revoke Access to a Device from a User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Revoke Access to a Device from a User Identity", "x-mint": { "href": "/api/user_identities/revoke_access_to_device" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.revokeAccessToDevice({\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/revoke_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->revoke_access_to_device(\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities revoke-access-to-device --user_identity_id \"a5a48343-a95e-4f51-a5d9-1e4241b73553\" --device_id \"92874f9e-a2b5-4d49-a039-0280196ad4d5\"\n\n# {}" } ] } }, "/user_identities/unmanaged/get": { "get": { "description": "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).", "operationId": "userIdentitiesUnmanagedGetGet", "parameters": [ { "in": "query", "name": "user_identity_id", "required": true, "schema": { "description": "ID of the unmanaged user identity that you want to get.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "user_identity": { "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object", "x-route-path": "/user_identities/unmanaged" } }, "required": [ "user_identity", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/unmanaged/get", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities", "unmanaged" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "user_identity", "x-response-key": "user_identity", "x-title": "Get an Unmanaged User Identity" }, "post": { "description": "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).", "operationId": "userIdentitiesUnmanagedGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_identity_id": { "description": "ID of the unmanaged user identity that you want to get.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "user_identity": { "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object", "x-route-path": "/user_identities/unmanaged" } }, "required": [ "user_identity" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get an Unmanaged User Identity", "tags": [ "/user_identities" ], "x-response-key": "user_identity", "x-title": "Get an Unmanaged User Identity", "x-mint": { "href": "/api/user_identities/unmanaged/get" } } }, "/user_identities/unmanaged/list": { "get": { "description": "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).", "operationId": "userIdentitiesUnmanagedListGet", "parameters": [ { "in": "query", "name": "search", "schema": { "description": "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `user_identity_id` or `acs_system_id`.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "created_before", "schema": { "description": "Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "page_cursor", "schema": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/pagination" }, "user_identities": { "items": { "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object", "x-route-path": "/user_identities/unmanaged" }, "type": "array" } }, "required": [ "user_identities", "pagination", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/unmanaged/list", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities", "unmanaged" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "user_identities", "x-response-key": "user_identities", "x-title": "List Unmanaged User Identities" }, "post": { "description": "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).", "operationId": "userIdentitiesUnmanagedListPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "created_before": { "description": "Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.", "format": "date-time", "type": "string" }, "limit": { "default": 500, "description": "Maximum number of records to return per page.", "exclusiveMinimum": true, "minimum": 0, "type": "integer" }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", "nullable": true, "type": "string" }, "search": { "description": "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `user_identity_id` or `acs_system_id`.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pagination": { "$ref": "#/components/schemas/pagination" }, "user_identities": { "items": { "description": "Represents an unmanaged user identity. Unmanaged user identities do not have keys.", "properties": { "acs_user_ids": { "description": "Array of access system user IDs associated with the user identity.", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "created_at": { "description": "Date and time at which the user identity was created.", "format": "date-time", "type": "string" }, "display_name": { "description": "Display name for the user identity.", "minLength": 1, "type": "string" }, "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "errors": { "description": "Array of errors associated with the user identity. Each error object within the array contains fields like \"error_code\" and \"message.\" \"error_code\" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Errors associated with the user identity.", "discriminator": { "propertyName": "error_code" }, "oneOf": [ { "description": "Indicates that there is an issue with an access system user associated with this user identity.", "properties": { "acs_system_id": { "description": "ID of the access system that the user identity is associated with.", "format": "uuid", "type": "string" }, "acs_user_id": { "description": "ID of the access system user that has an issue.", "format": "uuid", "type": "string" }, "created_at": { "description": "Date and time at which Seam created the error.", "format": "date-time", "type": "string" }, "error_code": { "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", "enum": [ "issue_with_acs_user" ], "type": "string" }, "message": { "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", "type": "string" } }, "required": [ "created_at", "message", "error_code", "acs_user_id", "acs_system_id" ], "type": "object", "x-resource-type": "user_identity" } ] }, "type": "array" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity.", "format": "uuid", "type": "string" }, "warnings": { "description": "Array of warnings associated with the user identity. Each warning object within the array contains two fields: \"warning_code\" and \"message.\" \"warning_code\" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. \"message\" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.", "items": { "description": "Warnings associated with the user identity.", "discriminator": { "propertyName": "warning_code" }, "oneOf": [ { "description": "Indicates that the user identity is currently being deleted.", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "being_deleted" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" }, { "description": "Indicates that the ACS user's profile does not match the user identity's profile", "properties": { "created_at": { "description": "Date and time at which Seam created the warning.", "format": "date-time", "type": "string" }, "message": { "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "type": "string" }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "enum": [ "acs_user_profile_does_not_match_user_identity" ], "type": "string" } }, "required": [ "created_at", "message", "warning_code" ], "type": "object" } ] }, "type": "array" }, "workspace_id": { "description": "ID of the workspace that contains the user identity.", "format": "uuid", "type": "string" } }, "required": [ "user_identity_id", "email_address", "phone_number", "display_name", "full_name", "created_at", "workspace_id", "errors", "warnings", "acs_user_ids" ], "type": "object", "x-route-path": "/user_identities/unmanaged" }, "type": "array" } }, "required": [ "user_identities", "pagination" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Unmanaged User Identities", "tags": [ "/user_identities" ], "x-response-key": "user_identities", "x-title": "List Unmanaged User Identities", "x-mint": { "href": "/api/user_identities/unmanaged/list" } } }, "/user_identities/unmanaged/update": { "patch": { "description": "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.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.", "operationId": "userIdentitiesUnmanagedUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "is_managed": { "description": "Must be set to true to convert the unmanaged user identity to managed.", "enum": [ true ], "type": "boolean" }, "user_identity_id": { "description": "ID of the unmanaged user identity that you want to update.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity. If not provided, the existing key will be preserved.", "type": "string" } }, "required": [ "user_identity_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/user_identities/unmanaged/update", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities", "unmanaged" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update an Unmanaged User Identity" }, "post": { "description": "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.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.", "operationId": "userIdentitiesUnmanagedUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "is_managed": { "description": "Must be set to true to convert the unmanaged user identity to managed.", "enum": [ true ], "type": "boolean" }, "user_identity_id": { "description": "ID of the unmanaged user identity that you want to update.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity. If not provided, the existing key will be preserved.", "type": "string" } }, "required": [ "user_identity_id", "is_managed" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "client_session": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Update an Unmanaged User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Update an Unmanaged User Identity", "x-mint": { "href": "/api/user_identities/unmanaged/update" } } }, "/user_identities/update": { "patch": { "description": "Updates a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity.", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to update.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity.", "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "/user_identities/update", "tags": [ "/user_identities" ], "x-fern-sdk-group-name": [ "user_identities" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a User Identity" }, "post": { "description": "Updates a specified [user identity](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", "operationId": "userIdentitiesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email_address": { "description": "Unique email address for the user identity.", "format": "email", "nullable": true, "type": "string" }, "full_name": { "description": "Full name of the user associated with the user identity.", "minLength": 1, "nullable": true, "type": "string" }, "phone_number": { "description": "Unique phone number for the user identity.", "nullable": true, "type": "string" }, "user_identity_id": { "description": "ID of the user identity that you want to update.", "format": "uuid", "type": "string" }, "user_identity_key": { "description": "Unique key for the user identity.", "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "user_identity_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "console_session_with_workspace": [] }, { "api_key": [] } ], "summary": "Update a User Identity", "tags": [ "/user_identities" ], "x-response-key": null, "x-title": "Update a User Identity", "x-mint": { "href": "/api/user_identities/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.userIdentities.update({\n user_identity_id: \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\",\n user_identity_key: \"jane_doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->user_identities->update(\n user_identity_id: \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\",\n user_identity_key: \"jane_doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam user-identities update --user_identity_id \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\" --user_identity_key \"jane_doe\" --email_address \"jane@example.com\" --phone_number \"+15551234567\" --full_name \"Jane Doe\"\n\n# {}" } ] } }, "/webhooks/create": { "post": { "description": "Creates a new [webhook](/developer-tools/webhooks).", "operationId": "webhooksCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "event_types": { "default": [ "*" ], "description": "Types of events that you want the new webhook to receive.", "items": { "type": "string" }, "type": "array" }, "url": { "description": "URL for the new webhook.", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "webhook": { "$ref": "#/components/schemas/webhook" } }, "required": [ "webhook" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Create a Webhook", "tags": [ "/webhooks" ], "x-response-key": "webhook", "x-title": "Create a Webhook", "x-mint": { "href": "/api/webhooks/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.webhooks.create({\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n});\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->webhooks->create(\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n);\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam webhooks create --url \"https://example.com\" --event_types [\"device.connected\",\"device.disconnected\"]\n\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }" } ] } }, "/webhooks/delete": { "delete": { "description": "Deletes a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksDeleteDelete", "parameters": [ { "in": "query", "name": "webhook_id", "required": true, "schema": { "description": "ID of the webhook that you want to delete.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/webhooks/delete", "tags": [ "/webhooks" ], "x-fern-sdk-group-name": [ "webhooks" ], "x-fern-sdk-method-name": "delete", "x-response-key": null, "x-title": "Delete a Webhook" }, "post": { "description": "Deletes a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksDeletePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "webhook_id": { "description": "ID of the webhook that you want to delete.", "type": "string" } }, "required": [ "webhook_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Delete a Webhook", "tags": [ "/webhooks" ], "x-response-key": null, "x-title": "Delete a Webhook", "x-mint": { "href": "/api/webhooks/delete" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.webhooks.delete({\n webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\");" }, { "lang": "bash", "label": "Seam CLI", "source": "seam webhooks delete --webhook_id \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\"\n\n# {}" } ] } }, "/webhooks/get": { "get": { "description": "Gets a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksGetGet", "parameters": [ { "in": "query", "name": "webhook_id", "required": true, "schema": { "description": "ID of the webhook that you want to get.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "webhook": { "$ref": "#/components/schemas/webhook" } }, "required": [ "webhook", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/webhooks/get", "tags": [ "/webhooks" ], "x-fern-sdk-group-name": [ "webhooks" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "webhook", "x-response-key": "webhook", "x-title": "Get a Webhook" }, "post": { "description": "Gets a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksGetPost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "webhook_id": { "description": "ID of the webhook that you want to get.", "type": "string" } }, "required": [ "webhook_id" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "webhook": { "$ref": "#/components/schemas/webhook" } }, "required": [ "webhook" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Get a Webhook", "tags": [ "/webhooks" ], "x-response-key": "webhook", "x-title": "Get a Webhook", "x-mint": { "href": "/api/webhooks/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.webhooks.get({ webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\" });\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->webhooks->get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\");\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam webhooks get --webhook_id \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n# }" } ] } }, "/webhooks/list": { "get": { "description": "Returns a list of all [webhooks](/developer-tools/webhooks).", "operationId": "webhooksListGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "webhooks": { "items": { "$ref": "#/components/schemas/webhook" }, "type": "array" } }, "required": [ "webhooks", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/webhooks/list", "tags": [ "/webhooks" ], "x-fern-sdk-group-name": [ "webhooks" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "webhooks", "x-response-key": "webhooks", "x-title": "List Webhooks" }, "post": { "description": "Returns a list of all [webhooks](/developer-tools/webhooks).", "operationId": "webhooksListPost", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "webhooks": { "items": { "$ref": "#/components/schemas/webhook" }, "type": "array" } }, "required": [ "webhooks" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "List Webhooks", "tags": [ "/webhooks" ], "x-response-key": "webhooks", "x-title": "List Webhooks", "x-mint": { "href": "/api/webhooks/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.webhooks.list();\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"webhooks\": [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.webhooks.list()\n\n# [\n Webhook(\n event_types=[\"device.connected\", \"device.disconnected\"],\n secret=\"mySecret\",\n url=\"https://example.com/webhook\",\n webhook_id=\"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.webhooks.list()\n\n# => [\n {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->webhooks->list();\n\n// [\n [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam webhooks list\n\n# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# ]" } ] } }, "/webhooks/update": { "post": { "description": "Updates a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "event_types": { "description": "Types of events that you want the webhook to receive.", "items": { "type": "string" }, "type": "array" }, "webhook_id": { "description": "ID of the webhook that you want to update.", "type": "string" } }, "required": [ "webhook_id", "event_types" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Update a Webhook", "tags": [ "/webhooks" ], "x-response-key": null, "x-title": "Update a Webhook", "x-mint": { "href": "/api/webhooks/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.webhooks.update({\n webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",\n event_types: [\n \"device.connected\",\n \"device.disconnected\",\n \"device.unmanaged.converted_to_managed\",\n ],\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->webhooks->update(\n webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",\n event_types: [\n \"device.connected\",\n \"device.disconnected\",\n \"device.unmanaged.converted_to_managed\",\n ],\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam webhooks update --webhook_id \"e294905f-e7a5-4804-95a6-303f440eb262\" --event_types [\"device.connected\",\"device.disconnected\",\"device.unmanaged.converted_to_managed\"]\n\n# {}" } ] }, "put": { "description": "Updates a specified [webhook](/developer-tools/webhooks).", "operationId": "webhooksUpdatePut", "requestBody": { "content": { "application/json": { "schema": { "properties": { "event_types": { "description": "Types of events that you want the webhook to receive.", "items": { "type": "string" }, "type": "array" }, "webhook_id": { "description": "ID of the webhook that you want to update.", "type": "string" } }, "required": [ "webhook_id", "event_types" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "/webhooks/update", "tags": [ "/webhooks" ], "x-fern-sdk-group-name": [ "webhooks" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Webhook" } }, "/workspaces/create": { "post": { "description": "Creates a new [workspace](/core-concepts/workspaces).", "operationId": "workspacesCreatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "company_name": { "description": "Company name for the new workspace.", "type": "string" }, "connect_partner_name": { "deprecated": true, "description": "Deprecated. Use `company_name` instead.\n\nConnect partner name for the new workspace.", "nullable": true, "type": "string" }, "connect_webview_customization": { "description": "[Connect Webview](/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "properties": { "logo_shape": { "description": "Logo shape for [Connect Webviews](/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "enum": [ "circle", "square" ], "nullable": true, "type": "string" }, "primary_button_color": { "description": "Primary button color for [Connect Webviews](/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "primary_button_text_color": { "description": "Primary button text color for [Connect Webviews](/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "success_message": { "description": "Success message for [Connect Webviews](/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" } }, "type": "object" }, "is_sandbox": { "default": false, "description": "Indicates whether the new workspace is a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces).", "type": "boolean" }, "name": { "description": "Name of the new workspace.", "type": "string" }, "organization_id": { "description": "ID of the organization to associate with the new workspace.", "format": "uuid", "type": "string" }, "webview_logo_shape": { "deprecated": true, "enum": [ "circle", "square" ], "type": "string", "description": "Deprecated. Use `connect_webview_customization.webview_logo_shape` instead." }, "webview_primary_button_color": { "deprecated": true, "type": "string", "description": "Deprecated. Use `connect_webview_customization.webview_primary_button_color` instead." }, "webview_primary_button_text_color": { "deprecated": true, "type": "string", "description": "Deprecated. Use `connect_webview_customization.webview_primary_button_text_color` instead." }, "webview_success_message": { "deprecated": true, "type": "string", "description": "Deprecated. Use `connect_webview_customization.webview_success_message` instead." } }, "required": [ "name" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workspace": { "$ref": "#/components/schemas/workspace" } }, "required": [ "workspace" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_without_workspace": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "summary": "Create a Workspace", "tags": [ "/workspaces" ], "x-response-key": "workspace", "x-title": "Create a Workspace", "x-mint": { "href": "/api/workspaces/create" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.workspaces.create({\n name: \"My Sandbox Workspace\",\n company_name: \"Acme\",\n connect_partner_name: \"Acme\",\n is_sandbox: true,\n is_publishable_key_auth_enabled: true,\n publishable_key: \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n webview_primary_button_color: \"#232426\",\n webview_primary_button_text_color: \"#FFFDE7\",\n webview_logo_shape: \"circle\",\n webview_success_message:\n \"Your account has been successfully connected to Acme!\",\n connect_webview_customization: {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n});\n\n/*\n{\n \"company_name\": \"Acme\",\n \"connect_partner_name\": \"Acme\",\n \"connect_webview_customization\": {\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\"\n },\n \"is_sandbox\": true,\n \"is_publishable_key_auth_enabled\": true,\n \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"is_suspended\": false,\n \"name\": \"My Sandbox Workspace\",\n \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"is_suspended\" => false,\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->workspaces->create(\n name: \"My Sandbox Workspace\",\n company_name: \"Acme\",\n connect_partner_name: \"Acme\",\n is_sandbox: true,\n is_publishable_key_auth_enabled: true,\n publishable_key: \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n webview_primary_button_color: \"#232426\",\n webview_primary_button_text_color: \"#FFFDE7\",\n webview_logo_shape: \"circle\",\n webview_success_message: \"Your account has been successfully connected to Acme!\",\n connect_webview_customization: [\n \"inviter_logo_url\" =>\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\" => \"circle\",\n \"primary_button_color\" => \"#232426\",\n \"primary_button_text_color\" => \"#FFFDE7\",\n \"success_message\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n);\n\n// [\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => [\n \"inviter_logo_url\" =>\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\" => \"circle\",\n \"primary_button_color\" => \"#232426\",\n \"primary_button_text_color\" => \"#FFFDE7\",\n \"success_message\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n \"is_sandbox\" => true,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"is_suspended\" => false,\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam workspaces create --name \"My Sandbox Workspace\" --company_name \"Acme\" --connect_partner_name \"Acme\" --is_sandbox true --is_publishable_key_auth_enabled true --publishable_key \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\" --webview_primary_button_color \"#232426\" --webview_primary_button_text_color \"#FFFDE7\" --webview_logo_shape \"circle\" --webview_success_message \"Your account has been successfully connected to Acme!\" --connect_webview_customization {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"}\n\n# {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"is_suspended\": false,\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }" } ] } }, "/workspaces/get": { "get": { "description": "Returns the [workspace](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesGetGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "workspace": { "$ref": "#/components/schemas/workspace" } }, "required": [ "workspace", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] } ], "summary": "/workspaces/get", "tags": [ "/workspaces" ], "x-fern-sdk-group-name": [ "workspaces" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "workspace", "x-response-key": "workspace", "x-title": "Get a Workspace" }, "post": { "description": "Returns the [workspace](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesGetPost", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workspace": { "$ref": "#/components/schemas/workspace" } }, "required": [ "workspace" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "client_session": [] }, { "client_session_with_customer": [] }, { "pat_with_workspace": [] } ], "summary": "Get a Workspace", "tags": [ "/workspaces" ], "x-response-key": "workspace", "x-title": "Get a Workspace", "x-mint": { "href": "/api/workspaces/get" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.workspaces.get();\n\n/*\n{\n \"company_name\": \"Acme\",\n \"connect_partner_name\": \"Acme\",\n \"connect_webview_customization\": {\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\"\n },\n \"is_sandbox\": true,\n \"is_suspended\": false,\n \"is_publishable_key_auth_enabled\": true,\n \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\": \"My Sandbox Workspace\",\n \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"workspace\": {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_suspended\": false,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.workspaces.get()\n\n# Workspace(\n company_name=\"Acme\",\n connect_partner_name=\"Acme\",\n connect_webview_customization={\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\",\n },\n is_sandbox=true,\n is_suspended=false,\n is_publishable_key_auth_enabled=true,\n publishable_key=\"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n name=\"My Sandbox Workspace\",\n workspace_id=\"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n)" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.workspaces.get()\n\n# => {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->workspaces->get();\n\n// [\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => [\n \"inviter_logo_url\" =>\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\" => \"circle\",\n \"primary_button_color\" => \"#232426\",\n \"primary_button_text_color\" => \"#FFFDE7\",\n \"success_message\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam workspaces get\n\n# {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_suspended\": false,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }" } ] } }, "/workspaces/list": { "get": { "description": "Returns a list of [workspaces](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesListGet", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "workspaces": { "items": { "$ref": "#/components/schemas/workspace" }, "type": "array" } }, "required": [ "workspaces", "ok" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "pat_without_workspace": [] }, { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "summary": "/workspaces/list", "tags": [ "/workspaces" ], "x-fern-sdk-group-name": [ "workspaces" ], "x-fern-sdk-method-name": "list", "x-fern-sdk-return-value": "workspaces", "x-response-key": "workspaces", "x-title": "List Workspaces" }, "post": { "description": "Returns a list of [workspaces](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesListPost", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "workspaces": { "items": { "$ref": "#/components/schemas/workspace" }, "type": "array" } }, "required": [ "workspaces" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "pat_with_workspace": [] }, { "pat_without_workspace": [] }, { "api_key": [] }, { "client_session": [] }, { "console_session_with_workspace": [] }, { "console_session_without_workspace": [] } ], "summary": "List Workspaces", "tags": [ "/workspaces" ], "x-response-key": "workspaces", "x-title": "List Workspaces", "x-mint": { "href": "/api/workspaces/list" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.workspaces.list();\n\n/*\n[\n {\n \"company_name\": \"Acme\",\n \"connect_partner_name\": \"Acme\",\n \"connect_webview_customization\": {\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\"\n },\n \"is_sandbox\": true,\n \"is_suspended\": false,\n \"is_publishable_key_auth_enabled\": true,\n \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\": \"My Sandbox Workspace\",\n \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n }\n]\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"workspaces\": [\n# {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_suspended\": false,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }\n# ]\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.workspaces.list()\n\n# [\n Workspace(\n company_name=\"Acme\",\n connect_partner_name=\"Acme\",\n connect_webview_customization={\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\",\n },\n is_sandbox=true,\n is_suspended=false,\n is_publishable_key_auth_enabled=true,\n publishable_key=\"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n name=\"My Sandbox Workspace\",\n workspace_id=\"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n )\n]" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.workspaces.list()\n\n# => [\n {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n },\n]" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->workspaces->list();\n\n// [\n [\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => [\n \"inviter_logo_url\" =>\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\" => \"circle\",\n \"primary_button_color\" => \"#232426\",\n \"primary_button_text_color\" => \"#FFFDE7\",\n \"success_message\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam workspaces list\n\n# [\n# {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_suspended\": false,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }\n# ]" } ] } }, "/workspaces/reset_sandbox": { "post": { "description": "Resets the [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.", "operationId": "workspacesResetSandboxPost", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "action_attempt": { "type": "object", "description": "Tracks the progress of this operation. Poll using the action_attempt_id. See the [action_attempt object](/api/action_attempts/object).", "properties": { "action_attempt_id": { "type": "string", "format": "uuid", "description": "ID of the action attempt." }, "action_type": { "type": "string", "enum": [ "RESET_SANDBOX_WORKSPACE" ], "description": "Type of action being tracked." }, "status": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Current status of the action." }, "result": { "type": "object", "nullable": true, "description": "Result payload on success." }, "error": { "type": "object", "nullable": true, "description": "Error details on failure.", "properties": { "type": { "type": "string" }, "message": { "type": "string" } } } }, "required": [ "action_attempt_id", "action_type", "status" ] } }, "required": [ "action_attempt" ], "type": "object" } } }, "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "pat_with_workspace": [] }, { "console_session_with_workspace": [] } ], "summary": "Reset a Sandbox Workspace", "tags": [ "/workspaces" ], "x-action-attempt-type": "RESET_SANDBOX_WORKSPACE", "x-response-key": "action_attempt", "x-title": "Reset a Sandbox Workspace", "x-mint": { "href": "/api/workspaces/reset_sandbox" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.workspaces.resetSandbox();\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/reset_sandbox\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\"\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" }, { "lang": "python", "label": "Seam SDK", "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(\n action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n action_type=\"RESET_SANDBOX_WORKSPACE\",\n error=None,\n result={},\n status=\"success\",\n)" }, { "lang": "ruby", "label": "Seam SDK", "source": "seam.workspaces.reset_sandbox()\n\n# => {\n \"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->workspaces->reset_sandbox();\n\n// [\n \"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\n \"error\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", "source": "seam workspaces reset-sandbox\n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } }, "/workspaces/update": { "patch": { "description": "Updates the [workspace](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesUpdatePatch", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_partner_name": { "description": "Connect partner name for the workspace.", "type": "string" }, "connect_webview_customization": { "description": "[Connect Webview](/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "properties": { "logo_shape": { "description": "Logo shape for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "enum": [ "circle", "square" ], "nullable": true, "type": "string" }, "primary_button_color": { "description": "Primary button color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "primary_button_text_color": { "description": "Primary button text color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "success_message": { "description": "Success message for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" } }, "type": "object" }, "is_publishable_key_auth_enabled": { "description": "Indicates whether publishable key authentication is enabled for this workspace.", "type": "boolean" }, "is_suspended": { "description": "Indicates whether the workspace is suspended.", "type": "boolean" }, "name": { "description": "Name of the workspace.", "type": "string" }, "organization_id": { "description": "ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "pat_with_workspace": [] } ], "summary": "/workspaces/update", "tags": [ "/workspaces" ], "x-fern-sdk-group-name": [ "workspaces" ], "x-fern-sdk-method-name": "update", "x-response-key": null, "x-title": "Update a Workspace" }, "post": { "description": "Updates the [workspace](/core-concepts/workspaces) associated with the authentication value.", "operationId": "workspacesUpdatePost", "requestBody": { "content": { "application/json": { "schema": { "properties": { "connect_partner_name": { "description": "Connect partner name for the workspace.", "type": "string" }, "connect_webview_customization": { "description": "[Connect Webview](/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "properties": { "logo_shape": { "description": "Logo shape for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "enum": [ "circle", "square" ], "nullable": true, "type": "string" }, "primary_button_color": { "description": "Primary button color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "primary_button_text_color": { "description": "Primary button text color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" }, "success_message": { "description": "Success message for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", "nullable": true, "type": "string" } }, "type": "object" }, "is_publishable_key_auth_enabled": { "description": "Indicates whether publishable key authentication is enabled for this workspace.", "type": "boolean" }, "is_suspended": { "description": "Indicates whether the workspace is suspended.", "type": "boolean" }, "name": { "description": "Name of the workspace.", "type": "string" }, "organization_id": { "description": "ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.", "format": "uuid", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" } }, "security": [ { "api_key": [] }, { "console_session_with_workspace": [] }, { "pat_with_workspace": [] } ], "summary": "Update a Workspace", "tags": [ "/workspaces" ], "x-response-key": null, "x-title": "Update a Workspace", "x-mint": { "href": "/api/workspaces/update" }, "x-codeSamples": [ { "lang": "javascript", "label": "Seam SDK", "source": "await seam.workspaces.update({\n name: \"My Workspace\",\n connect_partner_name: \"Acme\",\n connect_webview_customization: {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n is_suspended: true,\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" }, { "lang": "php", "label": "Seam SDK", "source": "$seam->workspaces->update(\n name: \"My Workspace\",\n connect_partner_name: \"Acme\",\n connect_webview_customization: [\n \"inviter_logo_url\" =>\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\" => \"circle\",\n \"primary_button_color\" => \"#232426\",\n \"primary_button_text_color\" => \"#FFFDE7\",\n \"success_message\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n is_suspended: true,\n);" }, { "lang": "bash", "label": "Seam CLI", "source": "seam workspaces update --name \"My Workspace\" --connect_partner_name \"Acme\" --connect_webview_customization {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"} --is_suspended true\n\n# {}" } ] } } } }