Get an Access Method

Gets an access method.

POST /access_methods/get

JavaScript

Seam SDK

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

/*
{
  "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"
}
*/

200

{
  "access_method": {
    "access_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "is_issued": true,
    "issued_at": "2023-11-07T05:31:56Z",
    "mode": "code",
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "from": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ]
        },
        "message": "<string>",
        "mutation_code": "provisioning_access",
        "to": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ]
        }
      }
    ],
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "warning_code": "being_deleted"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_session_token": "<string>",
    "code": "<string>",
    "customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instant_key_url": "<string>",
    "is_assignment_required": true,
    "is_encoding_required": true,
    "is_ready_for_assignment": true,
    "is_ready_for_encoding": true
  },
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

access_method_id · string<uuid> · required

ID of access method to get.

Response

200

application/json

OK

access_method · object · required

Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.

Show child attributes

ok · boolean · required