List Access Methods

await seam.accessMethods.list({
  access_grant_id: "9072ebcd-95f3-4e4b-8f2f-10053911533b",
});

/*
[
  {
    "access_method_id": "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
    "created_at": "2025-06-16T16:54:17.946606Z",
    "display_name": "PIN Code Credential",
    "is_card_encoding_required": false,
    "mode": "code",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  },
  {
    "access_method_id": "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    "created_at": "2025-06-16T16:54:19.946606Z",
    "display_name": "Card Credential",
    "is_card_encoding_required": true,
    "mode": "card",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  },
  {
    "access_method_id": "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "created_at": "2025-06-16T16:54:21.946606Z",
    "display_name": "Mobile Key Credential",
    "instant_key_url": "https://ik.seam.co/ABCXYZ",
    "is_card_encoding_required": false,
    "mode": "mobile_key",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
]
*/

{
  "access_methods": [
    {
      "access_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "failed_to_issue",
          "message": "<string>"
        }
      ],
      "is_issued": true,
      "issued_at": "2023-11-07T05:31:56Z",
      "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
    }
  ],
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

POST

access_methods

list

await seam.accessMethods.list({
  access_grant_id: "9072ebcd-95f3-4e4b-8f2f-10053911533b",
});

/*
[
  {
    "access_method_id": "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
    "created_at": "2025-06-16T16:54:17.946606Z",
    "display_name": "PIN Code Credential",
    "is_card_encoding_required": false,
    "mode": "code",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  },
  {
    "access_method_id": "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    "created_at": "2025-06-16T16:54:19.946606Z",
    "display_name": "Card Credential",
    "is_card_encoding_required": true,
    "mode": "card",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  },
  {
    "access_method_id": "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "created_at": "2025-06-16T16:54:21.946606Z",
    "display_name": "Mobile Key Credential",
    "instant_key_url": "https://ik.seam.co/ABCXYZ",
    "is_card_encoding_required": false,
    "mode": "mobile_key",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
]
*/

{
  "access_methods": [
    {
      "access_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "failed_to_issue",
          "message": "<string>"
        }
      ],
      "is_issued": true,
      "issued_at": "2023-11-07T05:31:56Z",
      "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
    }
  ],
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

access_code_id

string<uuid>

ID of the access code by which to filter the returned access methods. Must be combined with access_grant_id, access_grant_key, or acs_entrance_id.

access_grant_id

string<uuid>

ID of Access Grant to list access methods for.

access_grant_key

string

Key of Access Grant to list access methods for.

Minimum string length: 1

acs_entrance_id

string<uuid>

ID of the entrance for which you want to retrieve all access methods that grant access to it.

device_id

string<uuid>

ID of the device by which to filter the returned access methods. Must be combined with access_grant_id, access_grant_key, or acs_entrance_id.

limit

integer

default:500

Maximum number of records to return per page.

Required range: x > 0

page_cursor

string | null

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

space_id

string<uuid>

ID of the space by which to filter the returned access methods. Must be combined with access_grant_id, access_grant_key, or acs_entrance_id.

Response

access_methods

object[]

required

Show child attributes

pagination

object

required

Information about the current page of results.

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

List Access Methods

Authorizations

Body

Response