List Systems

Get all access control systems

Returns a list of all access control systems.

/acs/systems/list

POSThttps://connect.getseam.com/acs/systems/list

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

connected_account_idstring (uuid)

Response

200400401

OK

Body

application/json

acs_systems*array of acs_system (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/systems/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "acs_systems": [
    {
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "external_type": "pti_site",
      "external_type_display_name": "text",
      "system_type": "pti_site",
      "system_type_display_name": "text",
      "name": "text",
      "created_at": "2024-04-27T00:08:37.164Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "connected_account_ids": [
        "text"
      ],
      "image_url": "text",
      "image_alt_text": "text",
      "can_automate_enrollment": false,
      "can_create_acs_access_groups": false,
      "can_remove_acs_users_from_acs_access_groups": false,
      "can_add_acs_users_to_acs_access_groups": false
    }
  ],
  "ok": false
}

Request

To filter the list of returned access control systems by a specific connected account ID, include the connected_account_id in the request body. If you omit the connected_account_id parameter, the response includes all access control systems connected to your workspace.

Request Body Parameters

Parameter	Type	Description
connected_account_id	String (UUID) Optional	ID of the connected account

Sample Request

Python

seam.acs.systems.list()

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/systems/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json'

JavaScript

await seam.acs.systems.list();

Ruby

# Coming soon!

PHP

$seam->acs->systems->list();

C#

seam.SystemsAcs.List();

Java

// Coming soon!

Go

acs_systems, uErr := client.Acs.Systems.List(
  context.Background(), &acs.SystemsListRequest{},
)

Response

Returns an acs_systems array, in which each returned access control system (acs_system) contains the following properties:

Property	Description
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

Python

[
  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'
  ),
  ...
]

cURL (bash)

{
  "acs_systems": [
    {
      "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"
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    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'
  },
  ...
]

Ruby

# Coming soon!

PHP

[
  {
    "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"
  },
  ...
]

C#

{
  "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"
}
...

Java

// Coming soon!

Go

{
  "acs_systems": [
    {
      "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"
    },
    ...
  ],
  "ok": true
}