Get an Entrance

• Request Parameters

• Response

• Examples

Returns a specified access system entrance.

Signature

POST /acs/entrances/get ⇒ { acs_entrance }

Authentication Methods

• API key

• Client session token

To learn more, see Authentication.

Request Parameters

acs_entrance_id String (Required)

ID of the entrance that you want to get.

---

Response

acs_entrance

JSON

{
  JSON representation of acs_entrance
}

---

Examples

Get an entrance

Specify the acs_entrance_id of the entrance that you want to retrieve.

JavaScript

Code

await seam.acs.entrances.get({
  acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
});

Output

{
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-04-05T07:57:05.323Z",
  "display_name": "text"
}

Python

Code

seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000")

Output

AcsEntrance(
    acs_system_id="123e4567-e89b-12d3-a456-426614174000",
    acs_entrance_id="123e4567-e89b-12d3-a456-426614174000",
    created_at="2024-04-05T07:57:05.323Z",
    display_name="text",
)

Ruby

Code

seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000")

Output

{
  "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
  "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
  "created_at" => "2024-04-05T07:57:05.323Z",
  "display_name" => "text",
}

PHP

Code

<?php
$seam->acs->entrances->get(
    acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000"
);

Output

<?php
[
    "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
    "created_at" => "2024-04-05T07:57:05.323Z",
    "display_name" => "text",
];

Seam CLI

Code

seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"

Output

{
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-04-05T07:57:05.323Z",
  "display_name": "text"
}

Go

Code

package main

import api "github.com/seamapi/go"
import entrances "github.com/seamapi/go/entrances"

func main() {
	client.Acs.Entrances.Get(
		context.Background(),
		entrances.EntrancesGetRequest{
			AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
		},
	)
}

Output

api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/entrances/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000"
}
EOF

Output

{
  "acs_entrance": {
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-04-05T07:57:05.323Z",
    "display_name": "text"
  }
}