Get Toggle History

Get Activity for Door

GET https://app.beamlabs.io/api/oauth/v1/endpoints/toggle-history

Retrieve the toggle history for a single door for a given user.

Query Parameters

Name
Type
Description

end_date

string

Ending date of history (YYYY-MM-DD)

start_date

string

Starting date of history (YYYY-MM-DD)

history_type

string

"door"

door_id

string

UUID of Door

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": {
        "toggle_events": [
            {
                "door_id": "69668e34-2b60-49aa-b42a-7e01ebc0cb58",
                "door_name": "Main Door",
                "door_state": "OPEN",
                "channel": "Door Sensor",
                "user": {
                    "id": "",
                    "first_name": "John",
                    "last_name": "Doe",
                    "email_address": "test@example.com",
                },
                "was_success": true,
                "toggle_date_time": "2019-12-12"
            }
        ]
    }
}

The /toggle-history endpoint is used to retrieve the selected Controller's recent history. You can request the history of an entire Controller (ie. Device) or a specific Door. Furthermore, the history can be constrained to a particular time period via start_date and end_date.

An example request for a specific door may look like:

GET /api/oauth/v1/endpoints/toggle-history/?
    history_type=door&
    door_id=bbf8cf9aa86e396e2fcac0135177eecd&
    start_date=2016-04-01&
    end_date=2016-05-31 
    HTTP/1.1
Host: https://garageio.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate

where <ACCESS_TOKEN> is a valid access token.

If requesting the history of an entire device, it might resemble the following:

GET /api/oauth/v1/endpoints/toggle-history/?history_type=device&device_id=bbf8cf9aa86e396e2fcac01351771234&start_date=2016-04-01&end_date=<TODAY> HTTP/1.1
Host: https://garageio.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Accept-Charset: utf-8
Accept-Encoding: gzip, deflate

where <TODAY> is today's data with the format YYYY-MM-DD.

PreviousInvite User (internal)NextGet User Info

Last updated