search
Sign UpSupported Devices
githubEdit

List Entrances

Returns a list of all access system entrances.

Returns a list of all entrances for a specified access system.

Code:

await seam.acs.entrances.list({
  acs_system_id: "d34802da-d8e3-4d0b-98c3-16d6e18ed508",
});

Output:

[
  {
    "acs_entrance_id": "f74e4879-5991-4e2f-a368-888983dcfbfc",
    "acs_system_id": "d34802da-d8e3-4d0b-98c3-16d6e18ed508",
    "connected_account_id": "1b9a3e0d-443f-4063-b619-4ca7e2a97751",
    "created_at": "2025-06-15T16:54:17.946495Z",
    "display_name": "Main Entrance",
    "errors": [],
    "visionline_metadata": {
      "door_category": "guest",
      "door_name": "Main Entrance",
      "profiles": [
        {
          "visionline_door_profile_id": "7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
          "visionline_door_profile_type": "BLE"
        }
      ]
    }
  }
]
chevron-rightAuthentication Methodshashtag

  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authenticationarrow-up-right.

hashtag
Request Parameters

acs_credential_id String

ID of the credential for which you want to retrieve all entrances.

acs_entrance_ids Array of UUIDs

IDs of the entrances for which you want to retrieve all entrances.

acs_system_id String

ID of the access system for which you want to retrieve all entrances.

connected_account_id String

ID of the connected account for which you want to retrieve all entrances.

customer_key String

Customer key for which you want to list entrances.

limit Number

Maximum number of records to return per page.

location_id String

circle-exclamation

Deprecated. Use space_id.

page_cursor String

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

search String

String for which to search. Filters returned entrances to include all records that satisfy a partial match using display_name.

space_id String

ID of the space for which you want to list entrances.

hashtag
Response

circle-check

Returns: Array of acs_entrances

hashtag
Examples

hashtag
List entrances for a credential

Returns a list of all access system entrances for a specified credential.

Code:

Output:

hashtag
List entrances for a space

Returns a list of all access system entrances for a specified space.

Code:

Output:

hashtag
List entrances for an access grant

Returns a list of all access system entrances for a specified access grant.

Code:

Output:

hashtag
List entrances for an access method

Returns a list of all access system entrances for a specified access method.

Code:

Output:

PreviousList Credentials with Access to an EntranceNextSystems

Last updated

Was this helpful?