Skip to main content

​
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:
external_type Enum Brand-specific terminology for the access control system type.
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
name String Name of the access control system.
system_type Enum
Deprecated. Use external_type.
system_type_display_name String
Deprecated. Use external_type_display_name.
visionline_metadata Object
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:
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.
acs_system.added An access system was added.
acs_system.disconnected An access system was disconnected.

​
Endpoints

/acs/systems/get Returns a specified access system. /acs/systems/list 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. /acs/systems/report_devices Reports ACS system device status including encoders and entrances.