Get a System

Get a specified access control system

Returns a specified access control system.

/acs/systems/get

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

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

acs_system_id*string (uuid)

Response

200400401

OK

Body

application/json

acs_system*acs_system (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/systems/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "acs_system": {
    "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-26T17:41:33.617Z",
    "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

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

Request Body Parameters

Parameter	Type	Description
acs_system_id	String (UUID) Required	ID of the desired access control system

Sample Request

Python

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

cURL (bash)

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

JavaScript

await seam.acs.systems.get({
  acs_system_id: "11111111-1111-1111-1111-111111111111"
});

Ruby

# Coming soon!

PHP

$seam->acs->systems->get(
  acs_system_id: "11111111-1111-1111-1111-111111111111"
);

C#

seam.AcsSystems.Get(
  acsSystemId: "11111111-1111-1111-1111-111111111111"
);

Java

// Coming soon!

Go

acs_system, uErr := client.Acs.Systems.Get(
  context.Background(), &acs.SystemsGetRequest{
    AcsSystemId: "11111111-1111-1111-1111-111111111111",
  },
)

Response

Returns an acs_system containing 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_system": {
    "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_system": {
    "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
}