List Access Codes

Get all Access Codes of a Device by its ID

Get list of Access Codes

GET https://connect.getseam.com/access_codes/list

Query Parameters

Name	Type	Description
device_id*	String	ID of Device connected to account

200: OK

{
  "access_codes": [
    {
      "code": "1988",
      "type": "ongoing",
      "status": "setting",
      "created_at": "2022-08-26T12:50:17.858Z",
      "access_code_id": "26d6138c-6524-4f3c-ac96-43cc3bea0a8d"
    }
  ],
  "ok": true
}

400: Bad Request

{
  "error": {
    "type": "invalid_input",
    "message": "Required for provided \"device_id\"",
    "validation_errors": {
      "_errors": [],
      "device_id": {
        "_errors": [
          "Required"
        ]
      }
    },
    "request_id": "d7e371b4-b4d2-4373-93be-5e9e9e934aed"
  },
  "ok": false
}

404: Not Found

{
  "error": {
    "type": "device_not_found",
    "message": "Device not found",
    "request_id": "0cc082c2-d1fa-4fba-b8d5-80ae1e9a7839"
  },
  "ok": false
}

Code Example

Ruby

seam.access_codes.list("123e4567-e89b-12d3-a456-426614174000")

# [<Seam::AccessCode:0x007cd58                                       
#   code="669781"                                                   
#   name="My first code"                                            
#   type="ongoing"                                                  
#   created_at="2022-07-06T23:26:42.223Z"                           
#   access_code_id="f19bc8cb-15be-43af-bb52-f1a417e0ff09">]

Python

seam.access_codes.list("a83690b2-2b70-409a-9a94-426699b84c97")

# [AccessCode(
#   access_code_id='26d6138c-6524-4f3c-ac96-43cc3bea0a8d', 
#   type='ongoing', 
#   code='1988', 
#   starts_at=None, 
#   ends_at=None, 
#   name='', 
#   status='setting'
#   )
#  ]

Javascript

await seam.accessCodes.list({
    device_id: "a83690b2-2b70-409a-9a94-426699b84c97",
});

/*
[
  {
    code: '1988',
    type: 'ongoing',
    status: 'setting',
    created_at: '2022-08-26T12:50:17.858Z',
    access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d'
  }
]
*/

Parameters

device_id

type: string

ID of Device connected to account

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "access_codes": [
    {
      "code": "1988",
      "type": "ongoing",
      "status": "setting",
      "created_at": "2022-08-26T12:50:17.858Z",
      "access_code_id": "26d6138c-6524-4f3c-ac96-43cc3bea0a8d"
    }
  ],
  "ok": true
}