List Access Grants

Gets an Access Grant.

POST /access_grants/list

JavaScript

Seam SDK

await seam.accessGrants.list({
  user_identity_id: "f7620fcf-d92f-471e-b97e-3806daeebd40",
  acs_system_id: "9f169742-048a-4105-84e3-bd1e0f9dc790",
  acs_entrance_id: "2673b363-4748-4a64-8075-f669c862ec74",
  space_id: "1d20c47d-3cc0-41ca-9917-bc798d071543",
});

/*
[
  {
    "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 Credential",
          "mode": "code",
          "created_at": "2025-06-16T16:54:17.946606Z",
          "created_access_method_ids": [
            "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"
          ]
        },
        {
          "display_name": "Card Credential",
          "mode": "card",
          "created_at": "2025-06-16T16:54:19.946606Z",
          "created_access_method_ids": [
            "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"
          ]
        },
        {
          "display_name": "Mobile Key Credential",
          "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"
    }
  }
]
*/

200

{
  "access_grants": [
    {
      "access_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_method_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "ends_at": "2023-11-07T05:31:56Z",
      "errors": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>"
        }
      ],
      "location_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "name": "<string>",
      "pending_mutations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "from": {
            "device_ids": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ]
          },
          "message": "<string>",
          "to": {
            "device_ids": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "common_code_key": "<string>"
          }
        }
      ],
      "requested_access_methods": [
        {
          "created_access_method_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "display_name": "<string>",
          "code": "<string>",
          "instant_key_max_use_count": 2
        }
      ],
      "space_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "starts_at": "2023-11-07T05:31:56Z",
      "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "warnings": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_grant_key": "<string>",
      "client_session_token": "<string>",
      "customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "instant_key_url": "<string>",
      "reservation_key": "<string>"
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_keyclient_session_with_customer

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 you want to filter the list of Access Grants.

access_grant_ids · string<uuid>[]

IDs of the access grants to retrieve.

access_grant_key · string | null

Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.

acs_entrance_id · string<uuid>

ID of the entrance by which you want to filter the list of Access Grants.

acs_system_id · string<uuid>

ID of the access system by which you want to filter the list of Access Grants.

customer_key · string

Customer key for which you want to list access grants.

limit · number<float> · default: 500

Numerical limit on the number of access grants to return.

location_id · string<uuid> · deprecated

page_cursor · string | null

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

reservation_key · string

Filter Access Grants by reservation_key.

space_id · string<uuid>

ID of the space by which you want to filter the list of Access Grants.

user_identity_id · string<uuid>

ID of user identity by which you want to filter the list of Access Grants.

Response

200

application/json

OK

access_grants · object[] · required

Show child attributes

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes