🔏
API Docs
  • Beam API Docs
  • Overview
    • About Beam
    • API Requirements
    • Roles and Permissions
  • Getting Started
    • Requesting an Account
    • Using RESTful Tools
    • Webhooks
  • The Basics
    • Entities
    • Best Practices
    • Testing Accounts
  • OAuth
    • Overview
    • How to Authorize Access
      • Step 1: Generate Authorization URL
      • Step 2: Handle Authorization Response
      • Step 3: Request an Access Token
      • Step 4: Call API Endpoints
      • Step 5: Refresh the Tokens
  • API Endpoints
    • Overview
    • Get User Devices
    • Toggle Door
    • Invite User (internal)
    • Get Toggle History
    • Get User Info
    • Get User Settings
Powered by GitBook
On this page
  1. API Endpoints

Get User Settings

Get Device Settings

POST https://app.beamlabs.io/api/oauth/v1/endpoints/user-info

Retrieve settings for a given device (eg. whether autoclose is enabled, etc)

Headers

Name
Type
Description

Accept

string

Always set to application/json

Content-Type

string

Always set to application/json

Authorization

string

Set to Bearer <ACCESS_TOKEN>

Accept-Charset

string

Always set to utf-8

Accept-Encoding

string

Always set to gzip

{
    "success": true,
    "timestamp": ,
    "data": {
        "door_open_alert_notification_enabled": true,
        "door_open_alert_notification_tone": "door_open",
        "time_zone": "America/New_York",
        "pin_code": "1234"
    }
}
{
    "errors": [
        { 
            "message": "<ERROR MESSAGE>"
        }
    ]
}
{
    "errors": [
        { 
            "message": "<ERROR MESSAGE>"
        }
    ]
}
{
    "errors": [
        { 
            "message": "The server encountered an unexpected condition that prevented it from fulfilling the request."
        }
    ]
}

PreviousGet User Info

Last updated 4 years ago