search
Sign UpSupported Devices
githubEdit

Retrieving Access Grants and Access Methods

Learn how to list and get Access Grants and access methods.

circle-info

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

You can list all Access Grants, and you can also filter the list by one or more of the following properties:

  • acs_entrance_id

  • acs_system_id

  • space_id

  • user_identity_id

You can also list all access methods for a specified Access Grant. In addition, you can get a specific Access Grant or access method by its ID.

hashtag
List Access Grants

Code:

seam.access_grants.list()

Output:

[
  AccessGrant(
    access_grant={
      "access_grant_id": "704eadf0-a0a2-4715-b0e1-2f002dc1b6e0",
      "access_method_ids": [
        "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
        "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
        "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
      ],
      "created_at": "2025-06-16T16:54:17.946606Z",
      "display_name": "My Access Grant",
      "ends_at": "2025-06-18T16:54:17.946606Z",
      "instant_key_url": "https://ik.seam.co/ABCXYZ",
      "requested_access_methods": [
        {
          "display_name": "PIN Code",
          "mode": "code",
          "created_at": "2025-06-16T16:54:17.946606Z",
          "created_access_method_ids": [
            "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"
          ],
        },
        {
          "display_name": "Plastic Card",
          "mode": "card",
          "created_at": "2025-06-16T16:54:19.946606Z",
          "created_access_method_ids": [
              "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"
          ],
        },
        {
          "display_name": "Mobile Key",
          "mode": "mobile_key",
          "created_at": "2025-06-16T16:54:21.946606Z",
          "created_access_method_ids": [
              "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
          ],
        }
      ],
      "space_ids": [
        "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
      ],
      "starts_at": "2025-06-16T16:54:17.946606Z",
      "user_identity_id": "f7620fcf-d92f-471e-b97e-3806daeebd40",
      "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7",
    }
  ),
  ...
]

hashtag
List Access Grants for an Entrance

Code:

Output:

hashtag
List Access Grants for an Access System

Code:

Output:

hashtag
List Access Grants for a Space

Code:

Output:

hashtag
List Access Grants for a User Identity

Code:

Output:

hashtag
List Access Methods for an Access Grant

Code:

Output:

hashtag
Get an Access Grant

Code:

Output:

hashtag
Get an Access Method

Code:

Output:

PreviousReservation Access GrantsNextUpdating an Access Grant

Last updated

Was this helpful?