ReadonlydefaultsReadonlyltsStaticltsOptionalparameters: { Optionalallow_Optionalattempt_Optionalcode?: stringCode to be used for access.
Optionalcommon_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.
ID of the device for which you want to create the new access code.
Optionalends_Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalis_Indicates whether external modification of the code is allowed. Default: false.
Optionalis_Indicates whether the access code is an offline access code.
Optionalis_Indicates whether the offline access code is a single-use access code.
Optionalmax_Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.
Optionalname?: stringName of the new 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).
Optionalprefer_Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.
Optionalpreferred_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.
Optionalstarts_Date and time at which the validity of the new access code starts, in ISO 8601 format.
Optionalsync?: booleanOptionaluse_Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.
Optionaluse_Optionaloptions: AccessCodesCreateOptionsOptionalparameters: { Optionalallow_Indicates whether external modification of the code is allowed. Default: false.
Optionalattempt_Optionalbehavior_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.
Optionalcode?: stringCode to be used for access.
IDs of the devices for which you want to create the new access codes.
Optionalends_Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalis_Indicates whether external modification of the code is allowed. Default: false.
Optionalis_Indicates whether the access code is an offline access code.
Optionalis_Indicates whether the offline access code is a single-use access code.
Optionalmax_Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.
Optionalname?: stringName of the new 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).
Optionalprefer_Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.
Optionalpreferred_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.
Optionalstarts_Date and time at which the validity of the new access code starts, in ISO 8601 format.
Optionaluse_Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.
Optionaluse_Optionaloptions: AccessCodesCreateMultipleOptionsOptionalparameters: { ID of the access code that you want to delete.
Optionaldevice_ID of the device for which you want to delete the access code.
Optionalsync?: booleanOptionaloptions: AccessCodesDeleteOptionsOptionalparameters: { ID of the device for which you want to generate a code.
Optionaloptions: AccessCodesGenerateCodeOptionsOptionalparameters: { Optionalaccess_ID of the access code that you want to get. You must specify either access_code_id or both device_id and code.
Optionalcode?: stringCode of the access code that you want to get. You must specify either access_code_id or both device_id and code.
Optionaldevice_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.
Optionaloptions: AccessCodesGetOptionsOptionalparameters: { Optionalaccess_IDs of the access codes that you want to retrieve. Specify either device_id or access_code_ids.
Optionalcustomer_Optionaldevice_ID of the device for which you want to list access codes. Specify either device_id or access_code_ids.
Optionallimit?: numberNumerical limit on the number of access codes to return.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionaluser_Your user ID for the user by which to filter access codes.
Optionaloptions: AccessCodesListOptionsOptionalparameters: { ID of the access code for which you want to pull a backup access code.
Optionaloptions: AccessCodesPullBackupAccessCodeOptionsOptionalparameters: { ID of the device for which you want to report constraints.
Optionalmax_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.
Optionalmin_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.
Optionalsupported_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.
Optionaloptions: AccessCodesReportDeviceConstraintsOptionsOptionalparameters: { Code of the simulated unmanaged access code.
ID of the device for which you want to simulate the creation of an unmanaged access code.
Name of the simulated unmanaged access code.
Optionaloptions: AccessCodesSimulateCreateUnmanagedAccessCodeOptionsOptionalparameters: { ID of the unmanaged access code that you want to convert to a managed access code.
Optionalallow_Indicates whether external modification of the access code is allowed.
Optionalforce?: booleanIndicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set force to true.
Optionalis_Indicates whether external modification of the access code is allowed.
Optionalsync?: booleanOptionaloptions: AccessCodesUnmanagedConvertToManagedOptionsOptionalparameters: { ID of the unmanaged access code that you want to delete.
Optionalsync?: booleanOptionaloptions: AccessCodesUnmanagedDeleteOptionsOptionalparameters: { Optionalaccess_ID of the unmanaged access code that you want to get. You must specify either access_code_id or both device_id and code.
Optionalcode?: stringCode of the unmanaged access code that you want to get. You must specify either access_code_id or both device_id and code.
Optionaldevice_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.
Optionaloptions: AccessCodesUnmanagedGetOptionsOptionalparameters: { ID of the device for which you want to list unmanaged access codes.
Optionaluser_Your user ID for the user by which to filter unmanaged access codes.
Optionaloptions: AccessCodesUnmanagedListOptionsOptionalparameters: { ID of the unmanaged access code that you want to update.
Optionalallow_Indicates whether external modification of the code is allowed.
Optionalforce?: booleanIndicates whether to force the unmanaged access code update.
Optionalis_Indicates whether external modification of the code is allowed.
Optionaloptions: AccessCodesUnmanagedUpdateOptionsOptionalparameters: { ID of the access code that you want to update.
Optionalallow_Indicates whether external modification of the code is allowed. Default: false.
Optionalattempt_Optionalcode?: stringCode to be used for access.
Optionaldevice_ID of the device containing the access code that you want to update.
Optionalends_Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalis_Indicates whether external modification of the code is allowed. Default: false.
Optionalis_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.
Optionalis_Indicates whether the access code is an offline access code.
Optionalis_Indicates whether the offline access code is a single-use access code.
Optionalmax_Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.
Optionalname?: stringName of the new 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).
Optionalprefer_Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.
Optionalpreferred_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.
Optionalstarts_Date and time at which the validity of the new access code starts, in ISO 8601 format.
Optionalsync?: booleanOptionaltype?: "ongoing" | "time_bound"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.
Optionaluse_Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.
Optionaluse_Optionaloptions: AccessCodesUpdateOptionsOptionalparameters: { Key that links the group of access codes, assigned on creation by /access_codes/create_multiple.
Optionalends_Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalname?: stringName of the new 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).
Optionalstarts_Date and time at which the validity of the new access code starts, in ISO 8601 format.
Optionaloptions: AccessCodesUpdateMultipleOptionsOptionalparameters: AccessGrantsCreateParametersOptionaloptions: AccessGrantsCreateOptionsOptionalparameters: { ID of access grant to delete.
Optionaloptions: AccessGrantsDeleteOptionsOptionalparameters: { ID of access grant to get.
Optionaloptions: AccessGrantsGetOptionsOptionalparameters: { Optionalacs_ID of entrance to filter list of access grants by.
Optionalacs_ID of system to filter list of access grants by.
Optionallocation_Optionalspace_ID of space to filter list of access grants by.
Optionaluser_ID of user identity to filter list of access grants by.
Optionaloptions: AccessGrantsListOptionsOptionalparameters: { ID of the access grant to update.
Optionalends_Date and time at which the validity of the grant ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalstarts_Date and time at which the validity of the grant starts, in ISO 8601 format.
Optionaloptions: AccessGrantsUpdateOptionsOptionalparameters: { ID of access method to get.
Optionaloptions: AccessMethodsDeleteOptionsOptionalparameters: { ID of access method to get.
Optionaloptions: AccessMethodsGetOptionsOptionalparameters: { ID of access grant to list access methods for.
Optionaloptions: AccessMethodsListOptionsOptionalparameters: { ID of the access group to which you want to add an access system user.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsAccessGroupsAddUserOptionsOptionalparameters: { ID of the access group that you want to get.
Optionaloptions: AcsAccessGroupsGetOptionsOptionalparameters: { Optionalacs_ID of the access system for which you want to retrieve all access groups.
Optionalacs_ID of the access system user for which you want to retrieve all access groups.
Optionaluser_ID of the user identity for which you want to retrieve all access groups.
Optionaloptions: AcsAccessGroupsListOptionsOptionalparameters: { ID of the access group for which you want to retrieve all accessible entrances.
Optionaloptions: AcsAccessGroupsListAccessibleEntrancesOptionsOptionalparameters: { ID of the access group for which you want to retrieve all access system users.
Optionaloptions: AcsAccessGroupsListUsersOptionsOptionalparameters: { ID of the access group from which you want to remove an access system user.
Optionalacs_ID of the access system user that you want to remove from an access group.
Optionaluser_ID of the user identity associated with the user that you want to remove from an access group.
Optionaloptions: AcsAccessGroupsRemoveUserOptionsOptionalparameters: { ID of the unmanaged access group that you want to get.
Optionaloptions: AcsAccessGroupsUnmanagedGetOptionsOptionalparameters: { Optionalacs_ID of the access system for which you want to retrieve all unmanaged access groups.
Optionalacs_ID of the access system user for which you want to retrieve all unmanaged access groups.
Optionaloptions: AcsAccessGroupsUnmanagedListOptionsOptionalparameters: { ID of the access system for which you want to list credential pools.
Optionaloptions: AcsCredentialPoolsListOptionsOptionalparameters: { Optionalacs_ID of the credential pool for which you want to launch a credential provisioning automation.
Optionalcreate_Indicates whether to create an associated credential manager user. If you set create_credential_manager_user to true, you cannot specify a credential_manager_acs_user_id.
Access system ID of the credential manager for which you want to launch a credential provisioning automation.
Optionalcredential_ID of the associated access system user within the credential manager. If you specify a credential_manager_acs_user_id, you cannot set create_credential_manager_user to true.
ID of the user identity for which you want to launch a credential provisioning automation.
Optionaloptions: AcsCredentialProvisioningAutomationsLaunchOptionsOptionalparameters: { ID of the credential that you want to assign to an access system user.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsCredentialsAssignOptionsOptionalparameters: { Access method for the new credential. Supported values: code, card, mobile_key.
Optionalacs_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.
Optionalacs_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.
Optionalallowed_Set of IDs of the entrances for which the new credential grants access.
Optionalassa_Vostio-specific metadata for the new credential.
Optionalauto_Optionaljoin_Optionaloverride_Optionaloverride_Optionalcode?: stringAccess (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.
Optionalcredential_ACS system ID of the credential manager for the new credential.
Optionalends_Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalis_Indicates whether the new credential is a multi-phone sync credential.
Optionalsalto_Salto Space-specific metadata for the new credential.
Optionalassign_Indicates whether to assign a first, new card to a user. See also Programming Salto Space Card-based Credentials.
Optionalupdate_Indicates whether to update the user's existing card. See also Programming Salto Space Card-based Credentials.
Optionalstarts_Date and time at which the validity of the new credential starts, in ISO 8601 format.
Optionaluser_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.
Optionalvisionline_Visionline-specific metadata for the new credential.
Optionalassa_Optionalauto_Optionalcard_Optionalcard_Optionalis_Optionaljoiner_Optionaloverride?: booleanOptionaloptions: AcsCredentialsCreateOptionsOptionalparameters: { ID of the access system user to whom the new credential belongs.
IDs of the acs_entrances for which the new credential grants access.
Optionalends_Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.
Optionalis_Indicates whether the code is one-time-use or reusable.
Optionalstarts_Date and time at which the validity of the new credential starts, in ISO 8601 format.
Optionaloptions: AcsCredentialsCreateOfflineCodeOptionsOptionalparameters: { ID of the credential that you want to delete.
Optionaloptions: AcsCredentialsDeleteOptionsOptionalparameters: { ID of the credential that you want to get.
Optionaloptions: AcsCredentialsGetOptionsOptionalparameters: AcsCredentialsListParametersOptionaloptions: AcsCredentialsListOptionsOptionalparameters: { ID of the credential for which you want to retrieve all entrances to which the credential grants access.
Optionaloptions: AcsCredentialsListAccessibleEntrancesOptionsOptionalparameters: { ID of the credential that you want to unassign from an access system user.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsCredentialsUnassignOptionsOptionalparameters: { ID of the unmanaged credential that you want to get.
Optionaloptions: AcsCredentialsUnmanagedGetOptionsOptionalparameters: AcsCredentialsUnmanagedListParametersOptionaloptions: AcsCredentialsUnmanagedListOptionsOptionalparameters: { ID of the credential that you want to update.
Optionalcode?: stringReplacement access (PIN) code for the credential that you want to update.
Optionalends_Replacement date and time at which the validity of the credential ends, in ISO 8601 format. Must be a time in the future and after the starts_at value that you set when creating the credential.
Optionaloptions: AcsCredentialsUpdateOptionsOptionalparameters: { ID of the access_method to encode onto a card.
ID of the acs_encoder to use to encode the access_method.
Optionaloptions: AcsEncodersEncodeAccessMethodOptionsOptionalparameters: { ID of the acs_credential to encode onto a card.
ID of the acs_encoder to use to encode the acs_credential.
Optionaloptions: AcsEncodersEncodeCredentialOptionsOptionalparameters: { ID of the encoder that you want to get.
Optionaloptions: AcsEncodersGetOptionsOptionalparameters: AcsEncodersListParametersOptionaloptions: AcsEncodersListOptionsOptionalparameters: { ID of the encoder to use for the scan.
Optionaloptions: AcsEncodersScanCredentialOptionsOptionalparameters: AcsEncodersSimulateNextCredentialEncodeWillFailParametersOptionaloptions: AcsEncodersSimulateNextCredentialEncodeWillFailOptionsOptionalparameters: { ID of the acs_encoder that will be used in the next request to encode the acs_credential.
Optionalscenario?: "credential_is_issued"Scenario to simulate.
Optionaloptions: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptionsOptionalparameters: AcsEncodersSimulateNextCredentialScanWillFailParametersOptionaloptions: AcsEncodersSimulateNextCredentialScanWillFailOptionsOptionalparameters: AcsEncodersSimulateNextCredentialScanWillSucceedParametersOptionaloptions: AcsEncodersSimulateNextCredentialScanWillSucceedOptionsOptionalparameters: { ID of the entrance that you want to get.
Optionaloptions: AcsEntrancesGetOptionsOptionalparameters: { ID of the entrance to which you want to grant an access system user access.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsEntrancesGrantAccessOptionsOptionalparameters: { Optionalaccess_ID of the access grant for which you want to retrieve all entrances.
Optionalaccess_ID of the access method for which you want to retrieve all entrances.
Optionalacs_ID of the credential for which you want to retrieve all entrances.
Optionalacs_ID of the access system for which you want to retrieve all entrances.
Optionallocation_Optionalspace_ID of the space for which you want to list entrances.
Optionaloptions: AcsEntrancesListOptionsOptionalparameters: { ID of the entrance for which you want to list all credentials that grant access.
Optionalinclude_Conditions that credentials must meet to be included in the returned list.
Optionaloptions: AcsEntrancesListCredentialsWithAccessOptionsOptionalparameters: { ID of the access system that you want to get.
Optionaloptions: AcsSystemsGetOptionsOptionalparameters: { Optionalconnected_ID of the connected account by which you want to filter the list of access systems.
Optionaloptions: AcsSystemsListOptionsOptionalparameters: { ID of the access system for which you want to retrieve all compatible credential manager systems.
Optionaloptions: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptionsOptionalparameters: { ID of the access group to which you want to add an access system user.
ID of the access system user that you want to add to an access group.
Optionaloptions: AcsUsersAddToAccessGroupOptionsOptionalparameters: { Optionalaccess_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.
Optionalends_Ending timestamp for the new access system user's access.
Optionalstarts_Starting timestamp for the new access system user's access.
Optionalacs_Array of access group IDs to indicate the access groups to which you want to add the new access system user.
ID of the access system to which you want to add the new access system user.
Optionalemail?: stringOptionalemail_Email address of the access system user.
Full name of the new access system user.
Optionalphone_Phone number of the access system user in E.164 format (for example, +15555550100).
Optionaluser_ID of the user identity with which you want to associate the new access system user.
Optionaloptions: AcsUsersCreateOptionsOptionalparameters: { Optionalacs_ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
Optionalacs_ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
Optionaluser_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.
Optionaloptions: AcsUsersDeleteOptionsOptionalparameters: { Optionalacs_ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
Optionalacs_ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
Optionaluser_ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
Optionaloptions: AcsUsersGetOptionsOptionalparameters: { Optionalacs_ID of the acs_system for which you want to retrieve all access system users.
Optionalcreated_Timestamp by which to limit returned access system users. Returns users created before this timestamp.
Optionallimit?: numberMaximum number of records to return per page.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalsearch?: stringString 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.
Optionaluser_Email address of the user identity for which you want to retrieve all access system users.
Optionaluser_ID of the user identity for which you want to retrieve all access system users.
Optionaluser_Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, +15555550100).
Optionaloptions: AcsUsersListOptionsOptionalparameters: { Optionalacs_ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
Optionalacs_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.
Optionaluser_ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
Optionaloptions: AcsUsersListAccessibleEntrancesOptionsOptionalparameters: { ID of the access group from which you want to remove an access system user.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsUsersRemoveFromAccessGroupOptionsOptionalparameters: { Optionalacs_ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
Optionalacs_ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
Optionaluser_ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
Optionaloptions: AcsUsersRevokeAccessToAllEntrancesOptionsOptionalparameters: { Optionalacs_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.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsUsersSuspendOptionsOptionalparameters: { ID of the unmanaged access system user that you want to get.
Optionaloptions: AcsUsersUnmanagedGetOptionsOptionalparameters: { Optionalacs_ID of the access system for which you want to retrieve all unmanaged access system users.
Optionallimit?: numberNumber of unmanaged access system users to return.
Optionaluser_Email address of the user identity for which you want to retrieve all unmanaged access system users.
Optionaluser_ID of the user identity for which you want to retrieve all unmanaged access system users.
Optionaluser_Phone number of the user identity for which you want to retrieve all unmanaged access system users.
Optionaloptions: AcsUsersUnmanagedListOptionsOptionalparameters: { Optionalacs_ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
Optionalacs_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.
Optionaluser_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.
Optionaloptions: AcsUsersUnsuspendOptionsOptionalparameters: { Optionalaccess_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.
Optionalacs_ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
Optionalacs_ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
Optionalemail?: stringOptionalemail_Email address of the access system user.
Optionalfull_Full name of the access system user.
Optionalhid_Optionalphone_Phone number of the access system user in E.164 format (for example, +15555550100).
Optionaluser_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.
Optionaloptions: AcsUsersUpdateOptionsOptionalparameters: { ID of the action attempt that you want to get.
Optionaloptions: ActionAttemptsGetOptionsOptionalparameters: { IDs of the action attempts that you want to retrieve.
Optionaloptions: ActionAttemptsListOptionsOptionalparameters: { ID of the Seam Bridge that you want to get.
Optionaloptions: BridgesGetOptionsOptionalparameters: {}Optionaloptions: BridgesListOptionsOptionalparameters: { Optionalconnect_IDs of the Connect Webviews for which you want to create a client session.
Optionalconnected_IDs of the connected accounts for which you want to create a client session.
Optionalcustomer_Customer ID that you want to associate with the new client session.
Optionalcustomer_Customer key that you want to associate with the new client session.
Optionalexpires_Date and time at which the client session should expire, in ISO 8601 format.
Optionaluser_Your user ID for the user for whom you want to create a client session.
Optionaluser_ID of the user identity for which you want to create a client session.
Optionaluser_IDs of the user identities that you want to associate with the client session.
Optionaloptions: ClientSessionsCreateOptionsOptionalparameters: { ID of the client session that you want to delete.
Optionaloptions: ClientSessionsDeleteOptionsOptionalparameters: { Optionalclient_ID of the client session that you want to get.
Optionaluser_User identifier key associated with the client session that you want to get.
Optionaloptions: ClientSessionsGetOptionsOptionalparameters: { Optionalconnect_IDs of the Connect Webviews that you want to associate with the client session (or that are already associated with the existing client session).
Optionalconnected_IDs of the connected accounts that you want to associate with the client session (or that are already associated with the existing client session).
Optionalexpires_Date and time at which the client session should expire (or at which the existing client session expires), in ISO 8601 format.
Optionaluser_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).
Optionaluser_ID of the user identity that you want to associate with the client session (or that are already associated with the existing client session).
Optionaluser_IDs of the user identities that you want to associate with the client session.
Optionaloptions: ClientSessionsGetOrCreateOptionsOptionalparameters: { Optionalclient_ID of the client session to which you want to grant access to resources.
Optionalconnect_IDs of the Connect Webviews that you want to associate with the client session.
Optionalconnected_IDs of the connected accounts that you want to associate with the client session.
Optionaluser_Your user ID for the user that you want to associate with the client session.
Optionaluser_ID of the user identity that you want to associate with the client session.
Optionaluser_IDs of the user identities that you want to associate with the client session.
Optionaloptions: ClientSessionsGrantAccessOptionsOptionalparameters: { Optionalclient_ID of the client session that you want to retrieve.
Optionalconnect_ID of the Connect Webview for which you want to retrieve client sessions.
Optionaluser_Your user ID for the user by which you want to filter client sessions.
Optionaluser_ID of the user identity for which you want to retrieve client sessions.
Optionalwithout_Indicates whether to retrieve only client sessions without associated user identifier keys.
Optionaloptions: ClientSessionsListOptionsOptionalparameters: { ID of the client session that you want to revoke.
Optionaloptions: ClientSessionsRevokeOptionsOptionalparameters: { Optionalaccepted_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.
Optionalaccepted_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. To list all provider keys, use /devices/list_device_providers with no filters.
Optionalautomatically_Indicates whether newly-added devices should appear as managed devices. See also: Customize the Behavior Settings of Your Connect Webviews.
Optionalcustom_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 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 that were connected using the Connect Webview, making it easy to find and filter these resources in your workspace. You can also filter Connect Webviews by custom metadata.
Optionalcustom_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.
Optionalcustom_URL that you want to redirect the user to after the provider login is complete.
Optionalcustomer_Optionaldevice_Optionalprovider_Specifies the category of providers that you want to include. To list all providers within a category, use /devices/list_device_providers with the desired provider_category filter.
Optionalwait_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.
Optionaloptions: ConnectWebviewsCreateOptionsOptionalparameters: { ID of the Connect Webview that you want to delete.
Optionaloptions: ConnectWebviewsDeleteOptionsOptionalparameters: { ID of the Connect Webview that you want to get.
Optionaloptions: ConnectWebviewsGetOptionsOptionalparameters: { Optionalcustom_Custom metadata pairs by which you want to filter Connect Webviews. Returns Connect Webviews with custom_metadata that contains all of the provided key:value pairs.
Optionalcustomer_Optionallimit?: numberMaximum number of records to return per page.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionaluser_Your user ID for the user by which you want to filter Connect Webviews.
Optionaloptions: ConnectWebviewsListOptionsOptionalparameters: { ID of the connected account that you want to delete.
Optionalsync?: booleanOptionaloptions: ConnectedAccountsDeleteOptionsOptionalparameters: ConnectedAccountsGetParametersOptionaloptions: ConnectedAccountsGetOptionsOptionalparameters: { Optionalcustom_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.
Optionalcustomer_Optionallimit?: numberMaximum number of records to return per page.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionaluser_Your user ID for the user by which you want to filter connected accounts.
Optionaloptions: ConnectedAccountsListOptionsOptionalparameters: { ID of the connected account that you want to sync.
Optionaloptions: ConnectedAccountsSyncOptionsOptionalparameters: { Optionalautomatically_Indicates whether newly-added devices should appear as managed devices.
ID of the connected account that you want to update.
Optionalcustom_Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. 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.
Optionaloptions: ConnectedAccountsUpdateOptionsOptionalparameters: { ID of the device that you want to delete.
Optionaloptions: DevicesDeleteOptionsOptionalparameters: { Optionaldevice_ID of the device that you want to get.
Optionalname?: stringName of the device that you want to get.
Optionaloptions: DevicesGetOptionsOptionalparameters: { Optionalconnect_ID of the Connect Webview for which you want to list devices.
Optionalconnected_ID of the connected account for which you want to list devices.
Optionalconnected_Array of IDs of the connected accounts for which you want to list devices.
Optionalcreated_Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Optionalcustom_Set of key:value custom metadata pairs for which you want to list devices.
Optionalcustomer_Optionaldevice_Array of device IDs for which you want to list devices.
Optionaldevice_Device type for which you want to list devices.
Optionaldevice_Array of device types for which you want to list devices.
Optionalexclude_Optionalinclude_Optionallimit?: numberNumerical limit on the number of devices to return.
Optionalmanufacturer?: Manufacturer for which you want to list devices.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalspace_ID of the space for which you want to list devices.
Optionalunstable_Optionaluser_Your own internal user ID for the user for which you want to list devices.
Optionaloptions: DevicesListOptionsOptionalparameters: { Optionalprovider_Category for which you want to list providers.
Optionaloptions: DevicesListDeviceProvidersOptionsOptionalparameters: { ID of the device that you want to simulate connecting to Seam.
Optionaloptions: DevicesSimulateConnectOptionsOptionalparameters: { ID of the device that you want to simulate disconnecting from Seam.
Optionaloptions: DevicesSimulateDisconnectOptionsOptionalparameters: { ID of the device that you want to simulate removing from Seam.
Optionaloptions: DevicesSimulateRemoveOptionsOptionalparameters: { Optionaldevice_ID of the unmanaged device that you want to get.
Optionalname?: stringName of the unmanaged device that you want to get.
Optionaloptions: DevicesUnmanagedGetOptionsOptionalparameters: { Optionalconnect_ID of the Connect Webview for which you want to list devices.
Optionalconnected_ID of the connected account for which you want to list devices.
Optionalconnected_Array of IDs of the connected accounts for which you want to list devices.
Optionalcreated_Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Optionalcustom_Set of key:value custom metadata pairs for which you want to list devices.
Optionalcustomer_Optionaldevice_Array of device IDs for which you want to list devices.
Optionaldevice_Device type for which you want to list devices.
Optionaldevice_Array of device types for which you want to list devices.
Optionalexclude_Optionalinclude_Optionallimit?: numberNumerical limit on the number of devices to return.
Optionalmanufacturer?: Manufacturer for which you want to list devices.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalspace_ID of the space for which you want to list devices.
Optionalunstable_Optionaluser_Your own internal user ID for the user for which you want to list devices.
Optionaloptions: DevicesUnmanagedListOptionsOptionalparameters: { ID of the unmanaged device that you want to update.
Indicates whether the device is managed. Set this parameter to true to convert an unmanaged device to managed.
Optionaloptions: DevicesUnmanagedUpdateOptionsOptionalparameters: { Optionalcustom_Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. 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.
ID of the device that you want to update.
Optionalis_Indicates whether the device is managed. To unmanage a device, set is_managed to false.
Optionalname?: null | stringName for the device.
Optionalproperties?: { Optionalname?: null | stringName for the device.
Optionaloptions: DevicesUpdateOptionsOptionalparameters: { Optionaldevice_Unique identifier for the device that triggered the event that you want to get.
Optionalevent_Unique identifier for the event that you want to get.
Optionalevent_Type of the event that you want to get.
Optionaloptions: EventsGetOptionsOptionalparameters: { Optionalaccess_ID of the access code for which you want to list events.
Optionalaccess_IDs of the access codes for which you want to list events.
Optionalacs_ID of the access system for which you want to list events.
Optionalacs_IDs of the access systems for which you want to list events.
Optionalbetween?: (string | Date)[]Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include since or between.
Optionalconnect_IDs of the connected accounts for which you want to list events.
Optionalconnected_ID of the connected account for which you want to list events.
Optionalcustomer_IDs of the customers for which you want to list events.
Optionaldevice_ID of the device for which you want to list events.
Optionaldevice_IDs of the devices for which you want to list events.
Optionalevent_IDs of the events that you want to list.
Optionalevent_Type of the events that you want to list.
Optionalevent_Types of the events that you want to list.
Optionallimit?: numberNumerical limit on the number of events to return.
Optionalsince?: stringTimestamp to indicate the beginning generation time for the events that you want to list. You must include since or between.
Optionalunstable_Offset for the events that you want to list.
Optionaloptions: EventsListOptionsOptionalparameters: { Optionaldevice_ID of the lock that you want to get.
Optionalname?: stringName of the lock that you want to get.
Optionaloptions: LocksGetOptionsOptionalparameters: { Optionalconnect_ID of the Connect Webview for which you want to list devices.
Optionalconnected_ID of the connected account for which you want to list devices.
Optionalconnected_Array of IDs of the connected accounts for which you want to list devices.
Optionalcreated_Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Optionalcustom_Set of key:value custom metadata pairs for which you want to list devices.
Optionalcustomer_Optionaldevice_Array of device IDs for which you want to list devices.
Optionaldevice_Device type of the locks that you want to list.
Optionaldevice_Device types of the locks that you want to list.
Optionalexclude_Optionalinclude_Optionallimit?: numberNumerical limit on the number of devices to return.
Optionalmanufacturer?: Manufacturer of the locks that you want to list.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalspace_ID of the space for which you want to list devices.
Optionalunstable_Optionaluser_Your own internal user ID for the user for which you want to list devices.
Optionaloptions: LocksListOptionsOptionalparameters: { ID of the lock that you want to lock.
Optionalsync?: booleanOptionaloptions: LocksLockDoorOptionsOptionalparameters: { Code that you want to simulate entering on a keypad.
ID of the device for which you want to simulate a keypad code entry.
Optionaloptions: LocksSimulateKeypadCodeEntryOptionsOptionalparameters: { ID of the device for which you want to simulate a manual lock action using a keypad.
Optionaloptions: LocksSimulateManualLockViaKeypadOptionsOptionalparameters: { ID of the lock that you want to unlock.
Optionalsync?: booleanOptionaloptions: LocksUnlockDoorOptionsOptionalparameters: { Optionaloptions: NetworksGetOptionsOptionalparameters: {}Optionaloptions: NetworksListOptionsOptionalparameters: { Optionalconnect_ID of the Connect Webview for which you want to list devices.
Optionalconnected_ID of the connected account for which you want to list devices.
Optionalconnected_Array of IDs of the connected accounts for which you want to list devices.
Optionalcreated_Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Optionalcustom_Set of key:value custom metadata pairs for which you want to list devices.
Optionalcustomer_Optionaldevice_Array of device IDs for which you want to list devices.
Optionaldevice_Device type of the noise sensors that you want to list.
Optionaldevice_Device types of the noise sensors that you want to list.
Optionalexclude_Optionalinclude_Optionallimit?: numberNumerical limit on the number of devices to return.
Optionalmanufacturer?: "noiseaware" | "minut"Manufacturers of the noise sensors that you want to list.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalspace_ID of the space for which you want to list devices.
Optionalunstable_Optionaluser_Your own internal user ID for the user for which you want to list devices.
Optionaloptions: NoiseSensorsListOptionsOptionalparameters: { ID of the device for which you want to create a noise threshold.
Time at which the new noise threshold should become inactive daily.
Optionalname?: stringName of the new noise threshold.
Optionalnoise_Noise level in decibels for the new noise threshold.
Optionalnoise_Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for Noiseaware sensors.
Time at which the new noise threshold should become active daily.
Optionalsync?: booleanOptionaloptions: NoiseSensorsNoiseThresholdsCreateOptionsOptionalparameters: { ID of the device that contains the noise threshold that you want to delete.
ID of the noise threshold that you want to delete.
Optionalsync?: booleanOptionaloptions: NoiseSensorsNoiseThresholdsDeleteOptionsOptionalparameters: { ID of the noise threshold that you want to get.
Optionaloptions: NoiseSensorsNoiseThresholdsGetOptionsOptionalparameters: { ID of the device for which you want to list noise thresholds.
Optionalis_Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to true. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to false.
Optionaloptions: NoiseSensorsNoiseThresholdsListOptionsOptionalparameters: { ID of the device that contains the noise threshold that you want to update.
Optionalends_Time at which the noise threshold should become inactive daily.
Optionalname?: stringName of the noise threshold that you want to update.
Optionalnoise_Noise level in decibels for the noise threshold.
ID of the noise threshold that you want to update.
Optionalnoise_Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for Noiseaware sensors.
Optionalstarts_Time at which the noise threshold should become active daily.
Optionalsync?: booleanOptionaloptions: NoiseSensorsNoiseThresholdsUpdateOptionsOptionalparameters: { ID of the device for which you want to simulate the triggering of a noise threshold.
Optionaloptions: NoiseSensorsSimulateTriggerNoiseThresholdOptionsOptionalparameters: { Device ID of the phone that you want to deactivate.
Optionaloptions: PhonesDeactivateOptionsOptionalparameters: { Device ID of the phone that you want to get.
Optionaloptions: PhonesGetOptionsOptionalparameters: { Optionalacs_ID of the credential by which you want to filter the list of returned phones.
Optionalowner_ID of the user identity that represents the owner by which you want to filter the list of returned phones.
Optionaloptions: PhonesListOptionsOptionalparameters: { Optionalassa_ASSA ABLOY metadata that you want to associate with the simulated phone.
Optionalapplication_Application version that you want to use for the simulated phone.
Optionalble_Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.
Optionalhce_Indicates whether the simulated phone should have host card emulation (HCE) capability.
Optionalnfc_Indicates whether the simulated phone should have near-field communication (NFC) capability.
Optionalseos_SEOS applet version that you want to use for the simulated phone.
Optionalseos_ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.
Optionalcustom_ID of the custom SDK installation that you want to use for the simulated phone.
Optionalphone_Metadata that you want to associate with the simulated phone.
Optionaldevice_Manufacturer that you want to use for the simulated phone.
Optionaldevice_Device model that you want to use for the simulated phone.
Optionaloperating_Mobile operating system that you want to use for the simulated phone.
Optionalos_Mobile operating system version that you want to use for the simulated phone.
ID of the user identity that you want to associate with the simulated phone.
Optionaloptions: PhonesSimulateCreateSandboxPhoneOptionsOptionalparameters: { Identifier key of the client machine for the Seam Bridge client that you want to create.
Name of the Seam Bridge client that you want to create.
Time zone for the Seam Bridge client that you want to create.
Optionaloptions: SeamBridgeV1BridgeClientSessionsCreateOptionsOptionalparameters: {}Optionaloptions: SeamBridgeV1BridgeClientSessionsGetOptionsOptionalparameters: {}Optionaloptions: SeamBridgeV1BridgeClientSessionsRefreshTelemetryTokenOptionsOptionalparameters: {}Optionaloptions: SeamBridgeV1BridgeClientSessionsRegeneratePairingCodeOptionsOptionalparameters: { Indicates whether Tailscale is connected.
Tailscale IPv4 address.
Optionaloptions: SeamBridgeV1BridgeClientSessionsReportStatusOptionsOptionalparameters: {}Optionaloptions: SeamBridgeV1BridgeConnectedSystemsListOptionsOptionalparameters: { Short code that you want to exchange for a client session token.
Optionaloptions: SeamInstantKeyV1ClientSessionsExchangeShortCodeOptionsOptionalparameters: {}Optionaloptions: SeamMobileSdkV1AcsCredentialsListOptionsOptionalparameters: { ID of the custom SDK installation that you want to use for the new session.
Optionalphone_Phone device metadata that you want to use for the new session.
Optionalmanufacturer?: stringOptionalmodel?: stringOptionalos_Phone operating system that you want to use for the new session.
Optionaloptions: SeamMobileSdkV1PhoneSessionsGetOrCreateOptionsOptionalparameters: { Collection key.
Optionaloptions: SeamPartnerV1BuildingBlocksSpacesAutoMapOptionsOptionalparameters: { Optionalresource_Resource type alias by which you want to filter partner resources.
Optionaloptions: SeamPartnerV1ResourcesListOptionsOptionalparameters: { IDs of the entrances that you want to add to the space.
ID of the space to which you want to add entrances.
Optionaloptions: SpacesAddAcsEntrancesOptionsOptionalparameters: { IDs of the devices that you want to add to the space.
ID of the space to which you want to add devices.
Optionaloptions: SpacesAddDevicesOptionsOptionalparameters: { Optionalacs_IDs of the entrances that you want to add to the new space.
Optionaldevice_IDs of the devices that you want to add to the new space.
Name of the space that you want to create.
Optionaloptions: SpacesCreateOptionsOptionalparameters: { ID of the space that you want to delete.
Optionaloptions: SpacesDeleteOptionsOptionalparameters: { ID of the space that you want to get.
Optionaloptions: SpacesGetOptionsOptionalparameters: {}Optionaloptions: SpacesListOptionsOptionalparameters: { IDs of the entrances that you want to remove from the space.
ID of the space from which you want to remove entrances.
Optionaloptions: SpacesRemoveAcsEntrancesOptionsOptionalparameters: { IDs of the devices that you want to remove from the space.
ID of the space from which you want to remove devices.
Optionaloptions: SpacesRemoveDevicesOptionsOptionalparameters: { Optionalname?: stringName of the space.
ID of the space that you want to update.
Optionaloptions: SpacesUpdateOptionsOptionalparameters: { Climate preset key of the climate preset that you want to activate.
ID of the thermostat device for which you want to activate a climate preset.
Optionaloptions: ThermostatsActivateClimatePresetOptionsOptionalparameters: { Optionalcooling_Cooling set point in °C that you want to set for the thermostat. You must set one of the cooling_set_point parameters.
Optionalcooling_Cooling set point in °F that you want to set for the thermostat. You must set one of the cooling_set_point parameters.
ID of the thermostat device that you want to set to cool mode.
Optionalsync?: booleanOptionaloptions: ThermostatsCoolOptionsOptionalparameters: { Unique key to identify the climate preset.
Optionalcooling_Temperature to which the thermostat should cool (in °C). See also Set Points.
Optionalcooling_Temperature to which the thermostat should cool (in °F). See also Set Points.
ID of the thermostat device for which you want create a climate preset.
Optionalfan_Desired fan mode setting, such as on, auto, or circulate.
Optionalheating_Temperature to which the thermostat should heat (in °C). See also Set Points.
Optionalheating_Temperature to which the thermostat should heat (in °F). See also Set Points.
Optionalhvac_Desired HVAC mode setting, such as heat, cool, heat_cool, or off.
Optionalmanual_Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
Optionalname?: null | stringUser-friendly name to identify the climate preset.
Optionaloptions: ThermostatsCreateClimatePresetOptionsOptionalparameters: { ID of the thermostat device for which you want to create a daily program.
Name of the thermostat daily program.
Array of thermostat daily program periods.
Optionaloptions: ThermostatsDailyProgramsCreateOptionsOptionalparameters: { ID of the thermostat daily program that you want to delete.
Optionaloptions: ThermostatsDailyProgramsDeleteOptionsOptionalparameters: { Name of the thermostat daily program that you want to update.
Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.
ID of the thermostat daily program that you want to update.
Optionaloptions: ThermostatsDailyProgramsUpdateOptionsOptionalparameters: { Climate preset key of the climate preset that you want to delete.
ID of the thermostat device for which you want to delete a climate preset.
Optionaloptions: ThermostatsDeleteClimatePresetOptionsOptionalparameters: { Optionaldevice_ID of the thermostat device that you want to get.
Optionalname?: stringName of the thermostat device that you want to retrieve.
Optionaloptions: ThermostatsGetOptionsOptionalparameters: { ID of the thermostat device that you want to set to heat mode.
Optionalheating_Heating set point in °C that you want to set for the thermostat. You must set one of the heating_set_point parameters.
Optionalheating_Heating set point in °F that you want to set for the thermostat. You must set one of the heating_set_point parameters.
Optionalsync?: booleanOptionaloptions: ThermostatsHeatOptionsOptionalparameters: { Optionalcooling_Cooling set point in °C that you want to set for the thermostat. You must set one of the cooling_set_point parameters.
Optionalcooling_Cooling set point in °F that you want to set for the thermostat. You must set one of the cooling_set_point parameters.
ID of the thermostat device that you want to set to heat-cool mode.
Optionalheating_Heating set point in °C that you want to set for the thermostat. You must set one of the heating_set_point parameters.
Optionalheating_Heating set point in °F that you want to set for the thermostat. You must set one of the heating_set_point parameters.
Optionalsync?: booleanOptionaloptions: ThermostatsHeatCoolOptionsOptionalparameters: { Optionalconnect_ID of the Connect Webview for which you want to list devices.
Optionalconnected_ID of the connected account for which you want to list devices.
Optionalconnected_Array of IDs of the connected accounts for which you want to list devices.
Optionalcreated_Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Optionalcustom_Set of key:value custom metadata pairs for which you want to list devices.
Optionalcustomer_Optionaldevice_Array of device IDs for which you want to list devices.
Optionaldevice_Device type by which you want to filter thermostat devices.
Optionaldevice_Array of device types by which you want to filter thermostat devices.
Optionalexclude_Optionalinclude_Optionallimit?: numberNumerical limit on the number of devices to return.
Optionalmanufacturer?: Manufacturer by which you want to filter thermostat devices.
Optionalpage_Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
Optionalspace_ID of the space for which you want to list devices.
Optionalunstable_Optionaluser_Your own internal user ID for the user for which you want to list devices.
Optionaloptions: ThermostatsListOptionsOptionalparameters: { ID of the thermostat device that you want to set to off mode.
Optionalsync?: booleanOptionaloptions: ThermostatsOffOptionsOptionalparameters: { Key of the climate preset to use for the new thermostat schedule.
ID of the thermostat device for which you want to create a schedule.
Date and time at which the new thermostat schedule ends, in ISO 8601 format.
Optionalis_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.
Optionalmax_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.
Optionalname?: stringName of the thermostat schedule.
Date and time at which the new thermostat schedule starts, in ISO 8601 format.
Optionaloptions: ThermostatsSchedulesCreateOptionsOptionalparameters: { ID of the thermostat schedule that you want to delete.
Optionaloptions: ThermostatsSchedulesDeleteOptionsOptionalparameters: { ID of the thermostat schedule that you want to get.
Optionaloptions: ThermostatsSchedulesGetOptionsOptionalparameters: { ID of the thermostat device for which you want to list schedules.
Optionaluser_User identifier key by which to filter the list of returned thermostat schedules.
Optionaloptions: ThermostatsSchedulesListOptionsOptionalparameters: { Optionalclimate_Key of the climate preset to use for the thermostat schedule.
Optionalends_Date and time at which the thermostat schedule ends, in ISO 8601 format.
Optionalis_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.
Optionalmax_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.
Optionalname?: stringName of the thermostat schedule.
Optionalstarts_Date and time at which the thermostat schedule starts, in ISO 8601 format.
ID of the thermostat schedule that you want to update.
Optionaloptions: ThermostatsSchedulesUpdateOptionsOptionalparameters: { Climate preset key of the climate preset that you want to set as the fallback climate preset.
ID of the thermostat device for which you want to set the fallback climate preset.
Optionaloptions: ThermostatsSetFallbackClimatePresetOptionsOptionalparameters: { ID of the thermostat device for which you want to set the fan mode.
Optionalfan_Optionalfan_Fan mode setting that you want to set for the thermostat.
Optionalsync?: booleanOptionaloptions: ThermostatsSetFanModeOptionsOptionalparameters: ThermostatsSetHvacModeParametersOptionaloptions: ThermostatsSetHvacModeOptionsOptionalparameters: { ID of the thermostat device for which you want to set a temperature threshold.
Optionallower_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.
Optionallower_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.
Optionalupper_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.
Optionalupper_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.
Optionaloptions: ThermostatsSetTemperatureThresholdOptionsOptionalparameters: ThermostatsSimulateHvacModeAdjustedParametersOptionaloptions: ThermostatsSimulateHvacModeAdjustedOptionsOptionalparameters: { ID of the thermostat device that you want to simulate reaching a specified temperature.
Optionaltemperature_Temperature in °C that you want simulate the thermostat reaching. You must set temperature_celsius or temperature_fahrenheit.
Optionaltemperature_Temperature in °F that you want simulate the thermostat reaching. You must set temperature_fahrenheit or temperature_celsius.
Optionaloptions: ThermostatsSimulateTemperatureReachedOptionsOptionalparameters: { Unique key to identify the climate preset.
Optionalcooling_Temperature to which the thermostat should cool (in °C). See also Set Points.
Optionalcooling_Temperature to which the thermostat should cool (in °F). See also Set Points.
ID of the thermostat device for which you want to update a climate preset.
Optionalfan_Desired fan mode setting, such as on, auto, or circulate.
Optionalheating_Temperature to which the thermostat should heat (in °C). See also Set Points.
Optionalheating_Temperature to which the thermostat should heat (in °F). See also Set Points.
Optionalhvac_Desired HVAC mode setting, such as heat, cool, heat_cool, or off.
Optionalmanual_Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.
Optionalname?: null | stringUser-friendly name to identify the climate preset.
Optionaloptions: ThermostatsUpdateClimatePresetOptionsOptionalparameters: { ID of the thermostat device for which you want to update the weekly program.
Optionalfriday_ID of the thermostat daily program to run on Fridays.
Optionalmonday_ID of the thermostat daily program to run on Mondays.
Optionalsaturday_ID of the thermostat daily program to run on Saturdays.
Optionalsunday_ID of the thermostat daily program to run on Sundays.
Optionalthursday_ID of the thermostat daily program to run on Thursdays.
Optionaltuesday_ID of the thermostat daily program to run on Tuesdays.
Optionalwednesday_ID of the thermostat daily program to run on Wednesdays.
Optionaloptions: ThermostatsUpdateWeeklyProgramOptionsOptionalparameters: UnstableAccessGrantsCreateParametersOptionaloptions: UnstableAccessGrantsCreateOptionsOptionalparameters: { ID of access grant that you want to delete.
Optionaloptions: UnstableAccessGrantsDeleteOptionsOptionalparameters: { ID of access grant that you want to get.
Optionaloptions: UnstableAccessGrantsGetOptionsOptionalparameters: { Optionalacs_ID of the entrance by which you want to filter the list of access grants.
Optionalacs_ID of the access system by which you want to filter the list of access grants.
Optionallocation_Optionalspace_ID of the space by which you want to filter the list of access grants.
Optionaluser_ID of the user identity by which you want to filter the list of access grants.
Optionaloptions: UnstableAccessGrantsListOptionsOptionalparameters: { ID of the access method that you want to delete.
Optionaloptions: UnstableAccessMethodsDeleteOptionsOptionalparameters: { ID of the access method that you want to get.
Optionaloptions: UnstableAccessMethodsGetOptionsOptionalparameters: { ID of the access grant by which to filter the list of access methods.
Optionaloptions: UnstableAccessMethodsListOptionsOptionalparameters: { IDs of the entrances that you want to add to the location.
ID of the location to which you want to add entrances.
Optionaloptions: UnstableLocationsAddAcsEntrancesOptionsOptionalparameters: { IDs of the devices that you want to add to the location.
ID of the location to which you want to add devices.
Optionaloptions: UnstableLocationsAddDevicesOptionsOptionalparameters: { Optionalacs_IDs of the entrances that you want to add to the new location.
Optionaldevice_IDs of the devices that you want to add to the new location.
Optionalgeolocation?: { Geolocation of the new location.
Name of the new location.
Optionaltime_Time zone of the new location.
Optionaloptions: UnstableLocationsCreateOptionsOptionalparameters: { ID of the location that you want to delete.
Optionaloptions: UnstableLocationsDeleteOptionsOptionalparameters: { ID of the location that you want to get.
Optionaloptions: UnstableLocationsGetOptionsOptionalparameters: {}Optionaloptions: UnstableLocationsListOptionsOptionalparameters: { IDs of the entrances that you want to remove from the location.
ID of the location from which you want to remove entrances.
Optionaloptions: UnstableLocationsRemoveAcsEntrancesOptionsOptionalparameters: { IDs of the devices that you want to remove from the location.
ID of the location from which you want to remove devices.
Optionaloptions: UnstableLocationsRemoveDevicesOptionsOptionalparameters: { Optionalgeolocation?: { Geolocation of the location.
ID of the location that you want to update.
Optionalname?: stringName of the location.
Optionaltime_Time zone of the the location.
Optionaloptions: UnstableLocationsUpdateOptionsOptionalparameters: { Customer key for which you want to connect accounts.
Optionaloptions: UnstablePartnerBuildingBlocksConnectAccountsOptionsOptionalparameters: { Type of building block for which you want to create a magic link.
Customer key for which you want to create a new building block magic link.
Optionalspaces?: { Optional list of spaces that you want to include in the new building block magic link.
Optionaloptions: UnstablePartnerBuildingBlocksGenerateMagicLinkOptionsOptionalparameters: { Customer key for which you want to manage devices.
Optionaloptions: UnstablePartnerBuildingBlocksManageDevicesOptionsOptionalparameters: { Customer key for which you want to organize spaces.
Optionalspaces?: { Optional list of spaces that you want to include in the new building block magic link.
Optionaloptions: UnstablePartnerBuildingBlocksOrganizeSpacesOptionsOptionalparameters: UnstablePartnerResourcesPushParametersOptionaloptions: UnstablePartnerResourcesPushOptionsOptionalparameters: { ID of the access system user that you want to add to the user identity.
ID of the user identity to which you want to add an access system user.
Optionaloptions: UserIdentitiesAddAcsUserOptionsOptionalparameters: { Optionalacs_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.
Optionalemail_Unique email address for the new user identity.
Optionalfull_Full name of the user associated with the new user identity.
Optionalphone_Unique phone number for the new user identity in E.164 format (for example, +15555550100).
Optionaluser_Unique key for the new user identity.
Optionaloptions: UserIdentitiesCreateOptionsOptionalparameters: { ID of the user identity that you want to delete.
Optionaloptions: UserIdentitiesDeleteOptionsOptionalparameters: { ID of the enrollment automation that you want to delete.
Optionaloptions: UserIdentitiesEnrollmentAutomationsDeleteOptionsOptionalparameters: { ID of the enrollment automation that you want to get.
Optionaloptions: UserIdentitiesEnrollmentAutomationsGetOptionsOptionalparameters: { Optionalacs_ID of the credential pool from which to obtain credentials for the user identity.
Optionalcreate_Indicates whether to create an associated credential manager user. If you set create_credential_manager_user to true, you cannot specify a credential_manager_acs_user_id.
ID of the desired access system that serves as the credential manager for the enrollment automation.
Optionalcredential_ID of the associated access system user within the credential manager. If you specify a credential_manager_acs_user_id, you cannot set create_credential_manager_user to true.
ID of the user identity for which you want to launch an enrollment automation.
Optionaloptions: UserIdentitiesEnrollmentAutomationsLaunchOptionsOptionalparameters: { ID of the user identity for which you want to retrieve enrollment automations.
Optionaloptions: UserIdentitiesEnrollmentAutomationsListOptionsOptionalparameters: { Optionalmax_Maximum number of times the instant key can be used. Default: 1.
ID of the user identity for which you want to generate an instant key.
Optionaloptions: UserIdentitiesGenerateInstantKeyOptionsOptionalparameters: UserIdentitiesGetParametersOptionaloptions: UserIdentitiesGetOptionsOptionalparameters: { ID of the managed device to which you want to grant access to the user identity.
ID of the user identity that you want to grant access to a device.
Optionaloptions: UserIdentitiesGrantAccessToDeviceOptionsOptionalparameters: { Optionalcredential_acs_system_id of the credential manager by which you want to filter the list of user identities.
Optionaloptions: UserIdentitiesListOptionsOptionalparameters: { ID of the user identity for which you want to retrieve all accessible devices.
Optionaloptions: UserIdentitiesListAccessibleDevicesOptionsOptionalparameters: { ID of the user identity for which you want to retrieve all access systems.
Optionaloptions: UserIdentitiesListAcsSystemsOptionsOptionalparameters: { ID of the user identity for which you want to retrieve all access system users.
Optionaloptions: UserIdentitiesListAcsUsersOptionsOptionalparameters: { ID of the access system user that you want to remove from the user identity..
ID of the user identity from which you want to remove an access system user.
Optionaloptions: UserIdentitiesRemoveAcsUserOptionsOptionalparameters: { ID of the managed device to which you want to revoke access from the user identity.
ID of the user identity from which you want to revoke access to a device.
Optionaloptions: UserIdentitiesRevokeAccessToDeviceOptionsOptionalparameters: { Optionalemail_Unique email address for the user identity.
Optionalfull_Full name of the user associated with the user identity.
Optionalphone_Unique phone number for the user identity.
ID of the user identity that you want to update.
Optionaluser_Unique key for the user identity.
Optionaloptions: UserIdentitiesUpdateOptionsOptionalparameters: { Optionalevent_Types of events that you want the new webhook to receive.
URL for the new webhook.
Optionaloptions: WebhooksCreateOptionsOptionalparameters: { ID of the webhook that you want to delete.
Optionaloptions: WebhooksDeleteOptionsOptionalparameters: { ID of the webhook that you want to get.
Optionaloptions: WebhooksGetOptionsOptionalparameters: {}Optionaloptions: WebhooksListOptionsOptionalparameters: { Types of events that you want the webhook to receive.
ID of the webhook that you want to update.
Optionaloptions: WebhooksUpdateOptionsOptionalparameters: { Optionalcompany_Company name for the new workspace.
Optionalconnect_Connect partner name for the new workspace.
Optionalconnect_Connect Webview customizations for the new workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionallogo_Logo shape for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalprimary_Primary button color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalprimary_Primary button text color for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalsuccess_Success message for Connect Webviews in the new workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalis_Indicates whether the new workspace is a sandbox workspace.
Name of the new workspace.
Optionalwebview_Optionalwebview_Optionalwebview_Optionalwebview_Optionaloptions: WorkspacesCreateOptionsOptionalparameters: {}Optionaloptions: WorkspacesGetOptionsOptionalparameters: {}Optionaloptions: WorkspacesListOptionsOptionalparameters: {}Optionaloptions: WorkspacesResetSandboxOptionsOptionalparameters: { Optionalconnect_Connect partner name for the workspace.
Optionalconnect_Connect Webview customizations for the workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionallogo_Logo shape for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalprimary_Primary button color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalprimary_Primary button text color for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalsuccess_Success message for Connect Webviews in the workspace. See also Customize the Look and Feel of Your Connect Webviews.
Optionalis_Indicates whether the workspace is suspended.
Optionalname?: stringName of the workspace.
Optionaloptions: WorkspacesUpdateOptionsStaticfromStaticfromStaticfromStaticfromStaticfromStaticfrom
Indicates whether external modification of the code is allowed. Default:
false.