search
Sign UpSupported Devices
githubEdit

Creating Access Code CRUD Endpoints

hashtag
Overview

Access Codes CRUD endpoints Seam to list access codes created on a door lock.

hashtag
Listing Access Codes

After a Door Lock Owner logs in, Seam lists all the access codes programmed and shows them what's been programmed on the door lock. Your Door Locks system should return a JSON list of the access codes on a door lock.

hashtag
List all access codes for a lock

GET https://devicecloud.example.com/access_codes?lock_id=<LOCK_ID>

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer <access_token>

{
    "access_codes": [
        {
            "access_code_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "lock_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "owner_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "code": "1234",
            // Optional, but recommended
             "name": "Resident 001 Code"
        },
        {
            "access_code_id": "3043fde0-3c6d-4913-981f-2607f05fe743",
            "lock_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "owner_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "code": "2345",
            // Optional, but recommended
             "name": "Resident 002 Code"
        },
    ]
}

hashtag
Getting an Access Code

Seam may request access code information to display information about an access code to the connecting user.

hashtag
Get information about a single access code

GET https://devicecloud.example.com/access_codes/<ACCESS_CODE_ID>

hashtag
Query Parameters

Name
Type
Description

ACCESS_CODE_ID*

String

Identifier for Access Code

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer <access_token>

hashtag
Removing an Access Code

Seam needs to disable access codes. We need an endpoint to be able to remove an access code.

hashtag
Remove an access code

DELETE https://devicecloud.example.com/access_codes/<ACCESS_CODE_ID>

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer <access_token>

Content-Type*

String

application/json

PreviousCreating Door Lock CRUD EndpointsNextCreating the Health Endpoint

Last updated

Was this helpful?