🔏
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

Overview

PreviousStep 5: Refresh the TokensNextGet User Devices

Last updated 4 years ago

With access to the Beam API, you can leverage the following capabilities of a customer’s Beam-enabled device:

  • Open/close the garage

  • Notified (event-driven) of door alerts

  • Query a door’s state (either open or closed)

  • Read the activity of a door (user must be the account owner of the door, see section)

  • Get the user's basic information

  • Retrieve the user's account settings

Endpoints

Permissions
Get User Devices
Toggle Door
Invite User (internal)
Get Toggle History
Get User Info
Get User Settings