Skip to main content

​
Retrieving All Access Codes for a Device

To retrieve all access codes for a device, include the device_id in the List Access Codes request. Request: 
console.log(
  await seam.accessCodes.list({
    device_id: '6aae9d08-fed6-4ca5-8328-e36849ab48fe',
  }),
)
Response: 
[
  {
    "access_code_id": "80aa1afa-f0e5-43c2-96ea-6ab141112f9c",
    "device_id": "6aae9d08-fed6-4ca5-8328-e36849ab48fe",
    "name": "my time-bound code",
    "appearance": null,
    "code": "2345",
    "common_code_key": null,
    "type": "time_bound",
    "status": "unset",
    "is_scheduled_on_device": false,
    "starts_at": "2025-01-01T16:00:00.000Z",
    "ends_at": "2025-01-22T12:00:00.000Z",
    "pulled_backup_access_code_id": null,
    "is_backup_access_code_available": true,
    "created_at": "2023-10-19T09:36:51.663Z",
    "errors": [],
    "warnings": [],
    "is_managed": true,
    "is_external_modification_allowed": false
  },
  {
    "access_code_id": "f4780806-076e-4cec-8081-df0ea2139d5a",
    "device_id": "6aae9d08-fed6-4ca5-8328-e36849ab48fe",
    "name": "my ongoing code",
    "appearance": {
      "name": "my ongoing code",
      "last_name": "ongoing code",
      "first_name": "my"
    },
    "code": "1234",
    "common_code_key": null,
    "type": "ongoing",
    "status": "set",
    "pulled_backup_access_code_id": null,
    "is_backup_access_code_available": true,
    "created_at": "2023-10-19T09:30:58.399Z",
    "errors": [],
    "warnings": [],
    "is_managed": true,
    "is_external_modification_allowed": false
  }
]

​
Retrieving Access Codes Using Access Code IDs

To retrieve access codes by IDs, include the desired access_code_ids in the List Access Codes request. Request: 
const accessCodeIds = [
  '80aa1afa-f0e5-43c2-96ea-6ab141112f9c',
  'f4780806-076e-4cec-8081-df0ea2139d5a',
]
console.log(
  await seam.accessCodes.list({
    access_code_ids: accessCodeIds,
  }),
)
Response: 
[
  {
    "access_code_id": "80aa1afa-f0e5-43c2-96ea-6ab141112f9c",
    "device_id": "6aae9d08-fed6-4ca5-8328-e36849ab48fe",
    "name": "my time-bound code",
    "appearance": null,
    "code": "2345",
    "common_code_key": null,
    "type": "time_bound",
    "status": "unset",
    "is_scheduled_on_device": false,
    "starts_at": "2025-01-01T16:00:00.000Z",
    "ends_at": "2025-01-22T12:00:00.000Z",
    "pulled_backup_access_code_id": null,
    "is_backup_access_code_available": true,
    "created_at": "2023-10-19T09:36:51.663Z",
    "errors": [],
    "warnings": [],
    "is_managed": true,
    "is_external_modification_allowed": false
  },
  {
    "access_code_id": "f4780806-076e-4cec-8081-df0ea2139d5a",
    "device_id": "6aae9d08-fed6-4ca5-8328-e36849ab48fe",
    "name": "my ongoing code",
    "appearance": {
      "name": "my ongoing code",
      "last_name": "ongoing code",
      "first_name": "my"
    },
    "code": "1234",
    "common_code_key": null,
    "type": "ongoing",
    "status": "set",
    "pulled_backup_access_code_id": null,
    "is_backup_access_code_available": true,
    "created_at": "2023-10-19T09:30:58.399Z",
    "errors": [],
    "warnings": [],
    "is_managed": true,
    "is_external_modification_allowed": false
  }
]

​
Retrieving Individual Access Codes

To retrieve a specific access code, include the desired access_code_id in the Get Access Code request. Request: 
console.log(
  await seam.accessCodes.get({
    access_code_id: 'f4780806-076e-4cec-8081-df0ea2139d5a',
  }),
)
Response: 
{
  "access_code_id": "f4780806-076e-4cec-8081-df0ea2139d5a",
  "device_id": "6aae9d08-fed6-4ca5-8328-e36849ab48fe",
  "name": "my ongoing code",
  "appearance": {
    "name": "my ongoing code",
    "last_name": "ongoing code",
    "first_name": "my"
  },
  "code": "1234",
  "common_code_key": null,
  "type": "ongoing",
  "status": "set",
  "pulled_backup_access_code_id": null,
  "is_backup_access_code_available": true,
  "created_at": "2023-10-19T09:30:58.399Z",
  "errors": [],
  "warnings": [],
  "is_managed": true,
  "is_external_modification_allowed": false
}