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

NameTypeDescription

device_id*

String

ID of Device connected to account

{
  "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
}

Code Example

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">]

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

{
  "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
}

Last updated

Logo

Β© Seam Labs, Inc. All rights reserved.