Filter the list of returned access codes by device ID or access code IDs. You can also filter by user identifier key. You must include at least device_id
or access_code_ids
.
Python cURL (bash) JavaScript Ruby C# Java
Copy seam . access_codes . list (
device_id = "11111111-1111-1111-1111-444444444444"
)
Copy # Use GET or POST.
curl -X 'GET' \
'https://connect.getseam.com/access_codes/list' \
-H 'accept: application/json' \
-H "Authorization: Bearer ${API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"device_id": "11111111-1111-1111-1111-444444444444"
}'
Copy await seam . access_codes .list ({
device_id : "11111111-1111-1111-1111-444444444444"
})
Copy client . access_codes . list (
device_id: "11111111-1111-1111-1111-444444444444"
)
Copy seam . AccessCodes .List(
deviceId : "11111111-1111-1111-1111-444444444444"
);
Copy seam . accessCodes () . list ( AccessCodesListRequest . builder ()
. deviceId ( "11111111-1111-1111-1111-444444444444" )
. build ());
Python cURL (bash) JavaScript Ruby C# Java
Copy [
AccessCode(
access_code_id='1bbd1eba-e4a2-4f96-b1b9-8498a5405b2b',
device_id='11111111-1111-1111-1111-444444444444',
type='time_bound',
code='2345',
created_at='2023-10-19T02:21:58.738Z',
errors=[],
warnings=[],
starts_at='2025-01-01T16:00:00.000Z',
ends_at='2025-01-22T12:00:00.000Z',
name='my time-bound code',
status='unset',
common_code_key=None,
is_managed=True,
is_waiting_for_code_assignment=None,
is_scheduled_on_device=False,
pulled_backup_access_code_id=None,
is_backup_access_code_available=False,
is_backup=None,
appearance=None,
is_external_modification_allowed=False
),
...
]
Copy {
"access_codes" : [
{
"access_code_id" : "27afb24f-c0ae-4ea9-81af-f06fd08de09f" ,
"device_id" : "11111111-1111-1111-1111-444444444444" ,
"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-19T06:58:42.853Z" ,
"errors" : [] ,
"warnings" : [] ,
"is_managed" : true ,
"is_external_modification_allowed" : false
} ,
...
] ,
"ok" : true
}
Copy [
{
access_code_id : ' 80 aa 1 afa-f 0e5-43 c 2-96 ea -6 ab 141112 f 9 c' ,
device_id : ' 11111111-1111-1111-1111-444444444444 ' ,
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-01 T 16 : 00 : 00.000 Z' ,
ends_at : ' 2025-01-22 T 12 : 00 : 00.000 Z' ,
pulled_backup_access_code_id : null ,
is_backup_access_code_available : true ,
created_at : ' 2023-10-19 T 09 : 36 : 51.663 Z' ,
errors : [] ,
warnings : [] ,
is_managed : true ,
is_external_modification_allowed : false
} ,
...
]
Copy [
<Seam::AccessCode:0x00438
access_code_id="0d2c8b21-c71f-4301-82ea-22830f749d9b"
device_id="11111111-1111-1111-1111-444444444444"
name="my time-bound code"
appearance=nil
code="2345"
type="time_bound"
status="unset"
is_scheduled_on_device=false
starts_at=2025-01-01 16:00:00 UTC
ends_at=2025-01-22 12:00:00 UTC
pulled_backup_access_code_id=nil
is_backup_access_code_available=true
created_at=2023-10-23 20:56:49.213 UTC
errors=[]
warnings=[]
is_managed=true
is_external_modification_allowed=false
>,
...
]
Copy [
{
access_code_id : ' 80 aa 1 afa-f 0e5-43 c 2-96 ea -6 ab 141112 f 9 c' ,
device_id : ' 11111111-1111-1111-1111-444444444444 ' ,
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-01 T 16 : 00 : 00.000 Z' ,
ends_at : ' 2025-01-22 T 12 : 00 : 00.000 Z' ,
pulled_backup_access_code_id : null ,
is_backup_access_code_available : true ,
created_at : ' 2023-10-19 T 09 : 36 : 51.663 Z' ,
errors : [] ,
warnings : [] ,
is_managed : true ,
is_external_modification_allowed : false
} ,
...
]
Copy [
{
"is_scheduled_on_device" : false ,
"type" : "time_bound" ,
"access_code_id" : "48e8f0e3-11a4-49a4-b589-27a1baf7aee4" ,
"device_id" : "11111111-1111-1111-1111-444444444444" ,
"name" : "my time-bound code" ,
"code" : "2345" ,
"created_at" : "2023-10-30T03:50:17.802Z" ,
"errors" : [ ] ,
"warnings" : [ ] ,
"is_managed" : "true" ,
"starts_at" : "2025-01-01T16:00:00Z" ,
"ends_at" : "2025-01-22T12:00:00Z" ,
"status" : "unset" ,
"is_backup_access_code_available" : false
} ,
...
]