Systems
The acs_system Object
Represents an access control system.
Within an acs_system, create acs_users and acs_credentials to grant access to the acs_users.
For details about the resources associated with an access control system, see the access control systems namespace.
An access system resource.
{
"acs_access_group_count": 5,
"acs_system_id": "dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7",
"acs_user_count": 20,
"connected_account_id": "a94aeed0-1ae0-4e49-9c23-8444c7ceba09",
"connected_account_ids": ["a94aeed0-1ae0-4e49-9c23-8444c7ceba09"],
"created_at": "2025-06-15T16:54:17.946425Z",
"default_credential_manager_acs_system_id": "5dde2def-3507-44f5-9521-7ca96aa4cd18",
"errors": [],
"external_type": "salto_ks_site",
"external_type_display_name": "Salto KS site",
"image_alt_text": "Salto KS site Logo",
"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",
"is_credential_manager": false,
"location": { "time_zone": "America/New_York" },
"name": "My ACS System",
"warnings": [],
"workspace_id": "172920be-1f4d-45d4-8519-ecc3bdee638f"
}Properties
acs_access_group_count Number
acs_system_id UUID
ID of the access control system.
acs_user_count Number
connected_account_id UUID
ID of the connected account associated with the access control system.
connected_account_ids List of UUIDs
IDs of the connected accounts associated with the access control system.
Deprecated. Use connected_account_id.
created_at Datetime
Date and time at which the access control system was created.
default_credential_manager_acs_system_id UUID
ID of the default credential manager acs_system for this access control system.
errors List of Objects
Errors associated with the access control system.
The specific structure of each object in this list depends on the value of its error_code field.
Variants:
seam_bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if Seam Bridge is connected to the wrong workspace. See also Troubleshooting Your Access Control System.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
seam_bridge_disconnected
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
bridge_disconnected
is_bridge_error Boolean
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
visionline_instance_unreachable
Indicates that Seam Bridge is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises Visionline access control system. For example, the IP address of the on-premises access control system may be set incorrectly within the Seam workspace. See also Troubleshooting Your Access Control System.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
visionline_instance_unreachable
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_subscription_limit_exceeded
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.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_exceeded
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
acs_system_disconnected
Indicates that the access control system has been disconnected. See Troubleshooting Your Access Control System to resolve the issue.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
acs_system_disconnected
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
account_disconnected
Indicates that the login credentials are invalid. Reconnect the account using a Connect Webview to restore access.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
account_disconnected
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
salto_ks_certification_expired
Indicates that the access control system has lost its Salto KS certification. Contact support to regain access.
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_certification_expired
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
external_type Enum
Brand-specific terminology for the access control system type.
Enum values
pti_sitealta_orgsalto_ks_sitesalto_space_systembrivo_accounthid_credential_manager_organizationvisionline_systemassa_abloy_credential_servicelatch_buildingdormakaba_community_sitedormakaba_ambiance_sitelegic_connect_credential_serviceassa_abloy_vostioassa_abloy_vostio_credential_servicehotek_site
external_type_display_name String
Display name that corresponds to the brand-specific terminology for the access control system type.
image_alt_text String
Alternative text for the access control system image.
image_url String
URL for the image that represents the access control system.
is_credential_manager Boolean
Indicates whether the acs_system is a credential manager.
location Object
Child Properties
time_zoneStringTime zone in which the access control system is located.
name String
Name of the access control system.
system_type Enum
Deprecated. Use external_type.
Enum values
pti_sitealta_orgsalto_ks_sitesalto_space_systembrivo_accounthid_credential_manager_organizationvisionline_systemassa_abloy_credential_servicelatch_buildingdormakaba_community_sitedormakaba_ambiance_sitelegic_connect_credential_serviceassa_abloy_vostioassa_abloy_vostio_credential_servicehotek_site
system_type_display_name String
Deprecated. Use external_type_display_name.
visionline_metadata Object
Child Properties
lan_addressStringIP address or hostname of the main Visionline server relative to Seam Bridge on the local network.
mobile_access_uuidStringKeyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
system_idStringUnique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
warnings List of Objects
Warnings associated with the access control system.
The specific structure of each object in this list depends on the value of its warning_code field.
Variants:
salto_ks_subscription_limit_almost_reached
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.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_almost_reached
time_zone_does_not_match_location
Indicates the access control system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
misconfigured_acs_entrance_ids List of UUIDs
Deprecated. this field is deprecated.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
time_zone_does_not_match_location
workspace_id UUID
ID of the workspace that contains the access control system.
Errors
account_disconnected
Indicates that the login credentials are invalid. Reconnect the account using a Connect Webview to restore access.
acs_system_disconnected
Indicates that the access control system has been disconnected. See Troubleshooting Your Access Control System to resolve the issue.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
salto_ks_certification_expired
Indicates that the access control system has lost its Salto KS certification. Contact support to regain access.
salto_ks_subscription_limit_exceeded
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.
seam_bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if Seam Bridge is connected to the wrong workspace. See also Troubleshooting Your Access Control System.
visionline_instance_unreachable
Indicates that Seam Bridge is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises Visionline access control system. For example, the IP address of the on-premises access control system may be set incorrectly within the Seam workspace. See also Troubleshooting Your Access Control System.
Warnings
salto_ks_subscription_limit_almost_reached
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.
time_zone_does_not_match_location
Indicates the access control system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.
Events
acs_system.connected
An access system was connected.
Properties
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_system.connected
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
acs_system.added
An access system was added.
Properties
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_system.added
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
acs_system.disconnected
An access system was disconnected.
Properties
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_system.disconnected
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Returns a specified access system.
Returns a list of all access systems.
/acs/systems/list_compatible_credential_manager_acs_systems
Returns a list of all credential manager systems that are compatible with a specified access system.
Reports ACS system device status including encoders and entrances.
Last updated
Was this helpful?