List Entrances

Get all entrances

Returns a list of all entrances.

/acs/entrances/list

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

Authorization

api_keyclient_sessionpat_with_workspaceconsole_session

Body

application/json

acs_system_idstring (uuid)

acs_credential_idstring (uuid)

Response

200400401

OK

Body

application/json

acs_entrances*array of acs_entrance (object)

ok*boolean

Request

JavaScriptCurl

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

Response

{
  "acs_entrances": [
    {
      "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-04-27T12:07:25.749Z",
      "latch_metadata": {
        "accessibility_type": "text",
        "door_name": "text",
        "door_type": "text",
        "is_connected": false
      },
      "errors": [
        {
          "error_code": "text",
          "message": "text"
        }
      ],
      "visionline_metadata": {
        "door_name": "text",
        "door_category": "entrance",
        "profiles": [
          {
            "visionline_door_profile_id": "text",
            "visionline_door_profile_type": "BLE"
          }
        ]
      }
    }
  ],
  "ok": false
}

Request

To filter the list of returned entrances by a specific access control system or credential, include one or both of the acs_system_id or acs_credential_id parameters, respectively, in the request body. If you omit these parameters, the response includes all entrances in your workspace.

Request Body Parameters

Parameter	Type	Description
acs_system_id	String (UUID) Optional	ID of the access control system for which you want to retrieve all entrances
acs_credential_id	String (UUID) Optional	ID of the credential for which you want to retrieve all entrances

Sample Request

Python

seam.acs.entrances.list(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

cURL (bash)

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

JavaScript

await seam.acs.entrances.list({
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  acs_credential_id: "66666666-6666-6666-6666-666666666666"
});

Ruby

# Coming Soon!

PHP

$seam->acs->entrances->list(
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  acs_credential_id: "66666666-6666-6666-6666-666666666666"
);

C#

seam.EntrancesAcs.List(
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  acsCredentialId: "66666666-6666-6666-6666-666666666666"
);

Java

// Coming soon!

Go

acs_entrances, uErr := client.Acs.Entrances.List(
  context.Background(), &acs.EntrancesListRequest{
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
    AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
  },
)

Response

Returns an acs_entrances array, in which each returned entrance (acs_entrance) contains the following properties:

Property	Description
acs_entrance_id	ID of the entrance
acs_system_id	ID of the access control system that contains the entrance
workspace_id	ID of the workspace that contains the user
display_name	Display name for the entrance
XXX_metadata	ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
created_at	Date and time at which the entrance was created

Sample Response

This response contains manufacturer-specific metadata that may vary by manufacturer.

Python

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    visionline_metadata=
      profiles=[
        {
          'visionline_door_profile_id': 'Guest Door',
          'visionline_door_profile_type': 'BLE'
        }
      ],
      door_name='Guest Lock 2',
      door_category='guest'
    },
    latch_metadata=null,
    display_name='Guest Lock 2',
    created_at='2024-03-26T14:31:18.979Z'
  ),
  ...
]

cURL (bash)

{
  "acs_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "visionline_metadata": {
        "profiles": [
          {
            "visionline_door_profile_id": "Guest Door",
            "visionline_door_profile_type": "BLE"
          }
        ],
        "door_name": "Guest Lock 2",
        "door_category": "guest"
      },
      "latch_metadata": null,
      "display_name": "Guest Lock 2",
      "created_at": "2024-03-26T14:31:18.979Z"
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    acs_entrance_id: '55555555-5555-5555-5555-555555555555',
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    visionline_metadata: {
      profiles: [
        {
          visionline_door_profile_id: 'Guest Door',
          visionline_door_profile_type: 'BLE'
        }
      ],
      door_name: 'Guest Lock 2',
      door_category: 'guest'
    },
    latch_metadata: null,
    display_name: 'Guest Lock 2',
    created_at: '2024-03-26T14:31:18.979Z'
  },
  ...
]

Ruby

# Coming Soon!

PHP

[
  {
    "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "visionline_metadata": {
      "profiles": [
        {
          "visionline_door_profile_id": "Guest Door",
          "visionline_door_profile_type": "BLE"
        }
      ],
      "door_name": "Guest Lock 2",
      "door_category": "guest"
    },
    "latch_metadata": null,
    "display_name": "Guest Lock 2",
    "created_at": "2024-03-26T14:31:18.979Z"
  },
  ...
]

C#

{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "visionline_metadata": {
    "profiles": [
      {
        "visionline_door_profile_id": "Guest Door",
        "visionline_door_profile_type": "BLE"
      }
    ],
    "door_name": "Guest Lock 2",
    "door_category": "guest"
  },
  "latch_metadata": null,
  "display_name": "Guest Lock 2",
  "created_at": "2024-03-26T14:31:18.979Z"
}
...

Java

// Coming soon!

Go

{
  "acs_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "visionline_metadata": {
        "profiles": [
          {
            "visionline_door_profile_id": "Guest Door",
            "visionline_door_profile_type": "BLE"
          }
        ],
        "door_name": "Guest Lock 2",
        "door_category": "guest"
      },
      "latch_metadata": null,
      "display_name": "Guest Lock 2",
      "created_at": "2024-03-26T14:31:18.979Z"
    },
    ...
  ],
  "ok": true
}