Get a System

Get a specified access control system

Returns a specified access control system.

Request

Specify the desired access control system by including the corresponding acs_system_id in the request body.

Request Body Parameters

ParameterTypeDescription

acs_system_id

String (UUID) Required

ID of the desired access control system

Sample Request

seam.acs.systems.get(
 acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response

Returns an acs_system containing the following properties:

PropertyDescription

acs_system_id

ID of the access control system

name

Name of the access control system

workspace_id

ID of the workspace that contains the access control system

created_at

Date and time at which the access control system was created

external_type

Brand-specific terminology for the access control system type

external_type_display_name

Display name that corresponds to the brand-specific terminology for the access control system type

connected_account_ids

Array of connected account IDs associated with the access control system

image_url

URL for the image that represents the access control system

image_alt_text

Alternative text for the access control system image

Sample Response

AcsSystem(
  acs_system_id='11111111-1111-1111-1111-111111111111',
  name='Example Inc',
  workspace_id='00000000-0000-0000-0000-000000000000',
  created_at='2023-11-30T06:27:14.961Z',
  external_type='pti_site',
  external_type_display_name='PTI site",
  connected_account_ids=[
    '11111111-1111-1111-1111-222222222222'
  ],
  image_url='https://connect.getseam.com/assets/images/acs_systems/pti_site.png',
  image_alt_text='PTI site Logo'
)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.