Get an Access Method

Early Access Preview. The access methods API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.

• Request Parameters

• Response

Gets an access method.

JavaScript

Returns a specified access method.

Code:

await seam.accessMethods.get({
  access_method_id: "7410aea4-6bed-490c-a602-dd417d9cd075",
});

Output:

{
  "access_method_id": "7410aea4-6bed-490c-a602-dd417d9cd075",
  "created_at": "2025-06-14T16:54:17.946612Z",
  "display_name": "My Mobile Key",
  "instant_key_url": "https://ik.seam.co/ABCXYZ",
  "is_card_encoding_required": false,
  "mode": "mobile_key",
  "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
}

cURL

Returns a specified access method.

Code:

curl --include --request POST "https://connect.getseam.com/access_methods/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "access_method_id": "7410aea4-6bed-490c-a602-dd417d9cd075"
}
EOF

Output:

{
  "access_method": {
    "access_method_id": "7410aea4-6bed-490c-a602-dd417d9cd075",
    "created_at": "2025-06-14T16:54:17.946612Z",
    "display_name": "My Mobile Key",
    "instant_key_url": "https://ik.seam.co/ABCXYZ",
    "is_card_encoding_required": false,
    "mode": "mobile_key",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
}

Python

Returns a specified access method.

Code:

seam.access_methods.get(access_method_id="7410aea4-6bed-490c-a602-dd417d9cd075")

Output:

AccessMethod(
    access_method_id="7410aea4-6bed-490c-a602-dd417d9cd075",
    created_at="2025-06-14T16:54:17.946612Z",
    display_name="My Mobile Key",
    instant_key_url="https://ik.seam.co/ABCXYZ",
    is_card_encoding_required=false,
    mode="mobile_key",
    workspace_id="661025d3-c1d2-403c-83a8-af153aaedfbc",
)

Ruby

Returns a specified access method.

Code:

seam.access_methods.get(access_method_id: "7410aea4-6bed-490c-a602-dd417d9cd075")

Output:

{
  "access_method_id" => "7410aea4-6bed-490c-a602-dd417d9cd075",
  "created_at" => "2025-06-14T16:54:17.946612Z",
  "display_name" => "My Mobile Key",
  "instant_key_url" => "https://ik.seam.co/ABCXYZ",
  "is_card_encoding_required" => false,
  "mode" => "mobile_key",
  "workspace_id" => "661025d3-c1d2-403c-83a8-af153aaedfbc",
}

PHP

Returns a specified access method.

Code:

$seam->access_methods->get(
    access_method_id: "7410aea4-6bed-490c-a602-dd417d9cd075"
);

Output:

[
    "access_method_id" => "7410aea4-6bed-490c-a602-dd417d9cd075",
    "created_at" => "2025-06-14T16:54:17.946612Z",
    "display_name" => "My Mobile Key",
    "instant_key_url" => "https://ik.seam.co/ABCXYZ",
    "is_card_encoding_required" => false,
    "mode" => "mobile_key",
    "workspace_id" => "661025d3-c1d2-403c-83a8-af153aaedfbc",
];

Seam CLI

Returns a specified access method.

Code:

seam access-methods get --access_method_id "7410aea4-6bed-490c-a602-dd417d9cd075"

Output:

{
  "access_method_id": "7410aea4-6bed-490c-a602-dd417d9cd075",
  "created_at": "2025-06-14T16:54:17.946612Z",
  "display_name": "My Mobile Key",
  "instant_key_url": "https://ik.seam.co/ABCXYZ",
  "is_card_encoding_required": false,
  "mode": "mobile_key",
  "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
}

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

access_method_id String (Required)

ID of access method to get.

---

Response

access_method

JSON

{
  "access_method_id": "27d8ad77-55c2-4e20-b5b3-43555926f0e8",
  "created_at": "2025-06-14T16:54:17.946612Z",
  "display_name": "My Card",
  "is_card_encoding_required": true,
  "issued_at": "2025-06-14T16:54:17.946612Z",
  "mode": "card",
  "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
}